AthausDocs

Retrieve the calling key and its office

Request, parameters, response and errors of GET /v1/me.

Last updated:

Returns the office the API key acts for, the key itself (never its secret), what it may do (scopes and permissions), the country profiles of the office and the API version this response was produced with.

Requires the scope read.

Try it in the console

Request

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

Parameters

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/me" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with Me.

Me

FieldTypeDescription
objectstringAlways me.
officeobject
office.objectstringAlways office.
office.idstring
office.namestring | null
keyobject
key.objectstringAlways api_key.
key.idstring
key.namestring | null
key.prefixstringThe first characters of the key, enough to recognise it.
key.modestringOne of live, test.
key.scopesstring[]What the key may do, in the words of the proposal workflow: read, propose, approve. decide is separate: it lets the key approve and reject the proposals it created itself. One of read, propose, approve, decide.
key.permissionsobjectWhat the key may do per resource: none, read, write.
key.permissions.listingsstringOne of none, read, write.
key.permissions.contactsstringOne of none, read, write.
key.permissions.inquiriesstringOne of none, read, write.
key.permissions.viewingsstringOne of none, read, write.
key.permissions.filesstringOne of none, read, write.
key.permissions.webhookEndpointsstringOne of none, read, write.
key.permissions.apiKeysstringOne of none, read, write.
key.permissions.projectsstringOne of none, read, write.
key.createdAtstring (date-time)
key.lastUsedAtstring (date-time) | null
apiVersionstringThe version this response was produced with. Always v1.
profilesstring[]Country profiles enabled for this office, lower-case ISO 3166-1 alpha-2 codes (today: de). A countrySpecific section of another country is rejected with profile_unsupported.

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
400api_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