# Retrieve the calling key and its office

Adresse: https://docs.athaus.ai/api/v1/referenz/get-me

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

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

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`](/api/v1/anmeldung#scopes).

[In der Konsole ausprobieren](/api/v1/konsole?op=getMe)

## Aufruf [#aufruf]

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

### Parameter [#parameter]

**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 [#beispiel]

```bash
curl "https://api.athaus.ai/v1/me" \
  -H "Authorization: Bearer ath_live_..."
```

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `Me`.

### 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 [#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 [#fehler]

Jeder Fehler kommt als [Problem Details](/api/v1/fehler). Verzweige auf `code`, nicht auf `title` oder `detail`.

| Status | Codes                                                                                                            | Bedeutung                                                       |
| ------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| `400`  | [`api_version_unsupported`](/api/errors#api_version_unsupported)                                                 | Invalid request.                                                |
| `401`  | [`unauthorized`](/api/errors#unauthorized)                                                                       | Missing or invalid API key.                                     |
| `403`  | [`insufficient_permissions`](/api/errors#insufficient_permissions), [`plan_required`](/api/errors#plan_required) | The key lacks a right, or the plan does not include API access. |
| `404`  | [`not_found`](/api/errors#not_found)                                                                             | Nothing under this ID.                                          |
| `429`  | [`rate_limited`](/api/errors#rate_limited)                                                                       | Rate limit exceeded.                                            |
| `500`  | [`internal_error`](/api/errors#internal_error)                                                                   | Server error.                                                   |
