# Retrieve the calling key and its office

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

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

Type: Reference
Last updated: 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.

Requires the scope [`read`](/en/api/v1/anmeldung#scopes).

[Try it in the console](/en/api/v1/konsole?op=getMe)

## Request [#request]

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

### Parameters [#parameters]

**Header**

| Name             | Type     | Required | Description                                                                                                                                                  |
| ---------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Athaus-Version` | `string` | no       | 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`. |

### Example [#example]

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

## Response [#response]

On success the status is `200` with `Me`.

### Me [#me]

| Field                              | Type                         | Description                                                                                                                                                                                                                  |
| ---------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`                           | `string`                     | Always `me`.                                                                                                                                                                                                                 |
| `office`                           | `object`                     |                                                                                                                                                                                                                              |
| `office.object`                    | `string`                     | Always `office`.                                                                                                                                                                                                             |
| `office.id`                        | `string`                     |                                                                                                                                                                                                                              |
| `office.name`                      | `string \| null`             |                                                                                                                                                                                                                              |
| `key`                              | `object`                     |                                                                                                                                                                                                                              |
| `key.object`                       | `string`                     | Always `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`                     | One of `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. One of `read`, `propose`, `approve`, `decide`. |
| `key.permissions`                  | `object`                     | What the key may do per resource: none, read, write.                                                                                                                                                                         |
| `key.permissions.listings`         | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.contacts`         | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.inquiries`        | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.viewings`         | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.files`            | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.webhookEndpoints` | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.apiKeys`          | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.permissions.projects`         | `string`                     | One of `none`, `read`, `write`.                                                                                                                                                                                              |
| `key.createdAt`                    | `string (date-time)`         |                                                                                                                                                                                                                              |
| `key.lastUsedAt`                   | `string (date-time) \| null` |                                                                                                                                                                                                                              |
| `apiVersion`                       | `string`                     | The version this response was produced with. Always `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`.                                              |

### Response headers [#response-headers]

| Header             | Description                                                                                                     |
| ------------------ | --------------------------------------------------------------------------------------------------------------- |
| `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.                                                     |

## Errors [#errors]

Every error arrives as [problem details](/en/api/v1/fehler). Branch on `code`, not on `title` or `detail`.

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