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.
Aufruf
GET https://api.athaus.ai/v1/meParameter
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | Optional 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
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer me. |
office | object | |
office.object | string | Immer office. |
office.id | string | |
office.name | string | null | |
key | object | |
key.object | string | Immer api_key. |
key.id | string | |
key.name | string | null | |
key.prefix | string | The first characters of the key, enough to recognise it. |
key.mode | string | Eines von live, test. |
key.scopes | string[] | 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.permissions | object | What the key may do per resource: none, read, write. |
key.permissions.listings | string | Eines von none, read, write. |
key.permissions.contacts | string | Eines von none, read, write. |
key.permissions.inquiries | string | Eines von none, read, write. |
key.permissions.viewings | string | Eines von none, read, write. |
key.permissions.files | string | Eines von none, read, write. |
key.permissions.webhookEndpoints | string | Eines von none, read, write. |
key.permissions.apiKeys | string | Eines von none, read, write. |
key.permissions.projects | string | Eines von none, read, write. |
key.createdAt | string (date-time) | |
key.lastUsedAt | string (date-time) | null | |
apiVersion | string | The version this response was produced with. Immer v1. |
profiles | string[] | 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
| Kopf | Beschreibung |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | api_version_unsupported | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.