AthausDoku

Retrieve the calling key and its office

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

Zuletzt aktualisiert:

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.

Braucht den Scope read.

In der Konsole ausprobieren

Aufruf

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

Parameter

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

Antwort

Bei Erfolg kommt 200 mit Me.

Me

FeldTypBeschreibung
objectstringImmer me.
officeobject
office.objectstringImmer office.
office.idstring
office.namestring | null
keyobject
key.objectstringImmer api_key.
key.idstring
key.namestring | null
key.prefixstringThe first characters of the key, enough to recognise it.
key.modestringEines von 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. Eines von read, propose, approve, decide.
key.permissionsobjectWhat the key may do per resource: none, read, write.
key.permissions.listingsstringEines von none, read, write.
key.permissions.contactsstringEines von none, read, write.
key.permissions.inquiriesstringEines von none, read, write.
key.permissions.viewingsstringEines von none, read, write.
key.permissions.filesstringEines von none, read, write.
key.permissions.webhookEndpointsstringEines von none, read, write.
key.permissions.apiKeysstringEines von none, read, write.
key.permissions.projectsstringEines von none, read, write.
key.createdAtstring (date-time)
key.lastUsedAtstring (date-time) | null
apiVersionstringThe version this response was produced with. Immer 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.

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

Weiter lesen

Auf dieser Seite