AthausDocs

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.

Try it in the console

Request

GET https://api.athaus.ai/v1/apiKeys

Parameters

Query

NameTypeRequiredDescription
limitintegernoPage size, 1 to 100. More than 100 is rejected, never capped. Default 50.
cursorstringnoOpaque value from nextCursor of the previous page.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional 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

FieldTypeDescription
objectstringAlways list.
dataApiKey[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

ApiKey

FieldTypeDescription
objectstringAlways api_key.
idstring (uuid)
namestring | null
prefixstringThe first characters of the key, enough to recognise it. Never the key.
modestringOne of live, test.
scopesstring[]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.
permissionsobjectWhat the key may do per resource: none, read, write.
permissions.listingsstringOne of none, read, write.
permissions.contactsstringOne of none, read, write.
permissions.inquiriesstringOne of none, read, write.
permissions.viewingsstringOne of none, read, write.
permissions.filesstringOne of none, read, write.
permissions.webhookEndpointsstringOne of none, read, write.
permissions.apiKeysstringOne of none, read, write.
permissions.projectsstringOne of none, read, write.
currentbooleantrue for the key that made this request.
createdAtstring (date-time)
lastUsedAtstring (date-time) | nullAt most hourly exact. Null if it was never used.
revokedAtstring (date-time) | nullWhen the key was revoked. A revoked key answers 401 and stays listed for a year. Null while it works.

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400invalid_query, api_version_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page