List the API keys of the office
Request, parameters, response and errors of GET /v1/apiKeys.
Last updated:
Returns the keys of the office that have the same mode as the calling key (a test key sees test keys, a live key live keys), newest first, with their scopes, permissions, last use and, if revoked, the time of revocation. A revoked key stays listed for a year. The key itself is never part of an answer, only its prefix. Keys are created in the app, not here. Needs read access to apiKeys; only a key that the management of the office created can have it.
Requires the scope read.
Request
GET https://api.athaus.ai/v1/apiKeysParameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size, 1 to 100. More than 100 is rejected, never capped. Default 50. |
cursor | string | no | Opaque value from nextCursor of the previous page. |
Header
| Name | Type | Required | Description |
|---|---|---|---|
Athaus-Version | string | no | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
Example
curl "https://api.athaus.ai/v1/apiKeys?limit=10" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 200 with ApiKeyList.
ApiKeyList
| Field | Type | Description |
|---|---|---|
object | string | Always list. |
data | ApiKey[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
ApiKey
| Field | Type | Description |
|---|---|---|
object | string | Always api_key. |
id | string (uuid) | |
name | string | null | |
prefix | string | The first characters of the key, enough to recognise it. Never the key. |
mode | string | One of live, test. |
scopes | string[] | What the key may do: read, propose, approve, and decide where the key may say yes or no to a proposal. One of read, propose, approve, decide. |
permissions | object | What the key may do per resource: none, read, write. |
permissions.listings | string | One of none, read, write. |
permissions.contacts | string | One of none, read, write. |
permissions.inquiries | string | One of none, read, write. |
permissions.viewings | string | One of none, read, write. |
permissions.files | string | One of none, read, write. |
permissions.webhookEndpoints | string | One of none, read, write. |
permissions.apiKeys | string | One of none, read, write. |
permissions.projects | string | One of none, read, write. |
current | boolean | true for the key that made this request. |
createdAt | string (date-time) | |
lastUsedAt | string (date-time) | null | At most hourly exact. Null if it was never used. |
revokedAt | string (date-time) | null | When the key was revoked. A revoked key answers 401 and stays listed for a year. Null while it works. |
Response headers
| Header | Description |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_query, api_version_unsupported | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.