AthausDoku

List the API keys of the office

Aufruf, Parameter, Antwort und Fehler von GET /v1/apiKeys.

Zuletzt aktualisiert:

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.

Braucht den Scope read.

In der Konsole ausprobieren

Aufruf

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

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
cursorstringneinOpaque value from nextCursor of the previous page.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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.

Beispiel

curl "https://api.athaus.ai/v1/apiKeys?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit ApiKeyList.

ApiKeyList

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

ApiKey

FeldTypBeschreibung
objectstringImmer api_key.
idstring (uuid)
namestring | null
prefixstringThe first characters of the key, enough to recognise it. Never the key.
modestringEines von live, test.
scopesstring[]What the key may do: read, propose, approve, and decide where the key may say yes or no to a proposal. Eines von read, propose, approve, decide.
permissionsobjectWhat the key may do per resource: none, read, write.
permissions.listingsstringEines von none, read, write.
permissions.contactsstringEines von none, read, write.
permissions.inquiriesstringEines von none, read, write.
permissions.viewingsstringEines von none, read, write.
permissions.filesstringEines von none, read, write.
permissions.webhookEndpointsstringEines von none, read, write.
permissions.apiKeysstringEines von none, read, write.
permissions.projectsstringEines von 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.

Köpfe der Antwort

KopfBeschreibung
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.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
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.

Weiter lesen

Auf dieser Seite