AthausDocs

Retrieve an API key

Request, parameters, response and errors of GET /v1/apiKeys/{id}.

Last updated:

Returns one key of the office, never its secret. A key of another office, and a key of the other mode, is a 404. Needs read access to apiKeys.

Requires the scope read.

Try it in the console

Request

GET https://api.athaus.ai/v1/apiKeys/{id}

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the key.

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.
If-None-MatchstringnoAn ETag you hold. If it is still current, the answer is 304 without a body.

Example

curl "https://api.athaus.ai/v1/apiKeys/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with ApiKey.

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.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

With If-None-Match naming the current ETag, the operation answers 304 without a body.

Errors

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

StatusCodesMeaning
400invalid_id, api_version_unsupported, invalid_inputInvalid 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