Your personal API tokens
tokens
GET/api/v1/tokens
- Route
Every personal API token you've made, newest first, in all your households. The tokens themselves are only shown when made. Needs a session.
Response#
200 Your tokens.
| Field | Description |
|---|---|
itemsarray of objectsrequired | Your tokens, newest first. |
items[].idstringrequired | The token's ID, tok_…. It is also the part of the token before the dot. |
items[].household_idstringrequired | The household it reaches. |
items[].household_namestringrequired | That household's name. |
items[].namestringrequired | What it's for, as written when it was made. |
items[].accessone of: read_only, read_writerequired | read_only runs queries and reads files; read_write also runs commands and uploads files. |
items[].created_atstring (date-time)required | When it was made, UTC. |
items[].last_used_atstring (date-time) or nullrequired | When it was last used, UTC, to within an hour. Null if it never has been. |
next_cursornull or nullrequired | Always null: every token is on one page. |
Errors#
Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.
| Status | Code | When |
|---|---|---|
401 | unauthenticated | The request has no valid session. |
403 | Read error.code | Described above. |
Examples#
No call has been recorded for this operation yet, so this example is built from its schema. The values are placeholders.
Built from the schema
Not recorded from a real call: the fields are filled in from the schema, so the values are placeholders.
curl 'https://rigel.house/api/v1/tokens' \
-H "Cookie: rigel_session=$RIGEL_SESSION"const response = await fetch("https://rigel.house/api/v1/tokens", {
headers: {
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
});
const data = await response.json();GET /api/v1/tokens HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9BKNGK0ENW3AHRZ6DMV29GQ
{
"items": [
{
"id": "inv_01K9BKNGK0ENW3AHRZ6DMV29GQ",
"household_id": "hh_01K9BKQB60S07ENW3AHRZ6DMV2",
"household_name": "example",
"name": "Example",
"access": "read_only",
"created_at": "2026-11-06T18:00:00Z",
"last_used_at": "2026-11-06T18:00:00Z"
}
],
"next_cursor": null
}