# List the API keys of the office

Adresse: https://docs.athaus.ai/api/v1/referenz/list-api-keys

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

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Returns the keys of the office that have the same mode as the calling key (a test key sees test keys, a live key live keys), newest first, with their scopes, permissions, last use and, if revoked, the time of revocation. A revoked key stays listed for a year. The key itself is never part of an answer, only its prefix. Keys are created in the app, not here. Needs read access to `apiKeys`; only a key that the management of the office created can have it.

Braucht den Scope [`read`](/api/v1/anmeldung#scopes).

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

## Aufruf [#aufruf]

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

### Parameter [#parameter]

**Abfrage**

| Name     | Typ       | Pflicht | Beschreibung                                                                |
| -------- | --------- | ------- | --------------------------------------------------------------------------- |
| `limit`  | `integer` | nein    | Page size, 1 to 100. More than 100 is rejected, never capped. Vorgabe `50`. |
| `cursor` | `string`  | nein    | Opaque value from `nextCursor` of the previous page.                        |

**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/apiKeys?limit=10" \
  -H "Authorization: Bearer ath_live_..."
```

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `ApiKeyList`.

### ApiKeyList [#apikeylist]

| Feld         | Typ              | Beschreibung                                                  |
| ------------ | ---------------- | ------------------------------------------------------------- |
| `object`     | `string`         | Immer `list`.                                                 |
| `data`       | `ApiKey[]`       |                                                               |
| `hasMore`    | `boolean`        | True if another page follows.                                 |
| `nextCursor` | `string \| null` | Pass as `cursor` to get the next page. Null on the last page. |

### ApiKey [#apikey]

| Feld                           | Typ                          | Beschreibung                                                                                                                                             |
| ------------------------------ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`                       | `string`                     | Immer `api_key`.                                                                                                                                         |
| `id`                           | `string (uuid)`              |                                                                                                                                                          |
| `name`                         | `string \| null`             |                                                                                                                                                          |
| `prefix`                       | `string`                     | The first characters of the key, enough to recognise it. Never the key.                                                                                  |
| `mode`                         | `string`                     | Eines von `live`, `test`.                                                                                                                                |
| `scopes`                       | `string[]`                   | What the key may do: read, propose, approve, and decide where the key may say yes or no to a proposal. Eines von `read`, `propose`, `approve`, `decide`. |
| `permissions`                  | `object`                     | What the key may do per resource: none, read, write.                                                                                                     |
| `permissions.listings`         | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.contacts`         | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.inquiries`        | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.viewings`         | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.files`            | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.webhookEndpoints` | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.apiKeys`          | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `permissions.projects`         | `string`                     | Eines von `none`, `read`, `write`.                                                                                                                       |
| `current`                      | `boolean`                    | `true` for the key that made this request.                                                                                                               |
| `createdAt`                    | `string (date-time)`         |                                                                                                                                                          |
| `lastUsedAt`                   | `string (date-time) \| null` | At most hourly exact. Null if it was never used.                                                                                                         |
| `revokedAt`                    | `string (date-time) \| null` | When the key was revoked. A revoked key answers 401 and stays listed for a year. Null while it works.                                                    |

### 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`  | [`invalid_query`](/api/errors#invalid_query), [`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.                                                   |
