# List events

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

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

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Returns what happened in the office during the last 30 days, newest first: new inquiries and messages, booked, cancelled and upcoming viewings, processed files. Filter by `type` and by time with `createdSince` and `createdBefore`. A key sees only the events of the resources it may read; asking for a `type` outside that is a 403. `data.object` is the resource as `GET` returns it now, not as it was when the event happened. Needs the right `lesen`.

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

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

## Aufruf [#aufruf]

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

### 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.                                                                                                                                                                                     |
| `type`          | `string`             | nein    | Only events of this type. Eines von `inquiry.received`, `message.received`, `viewing.booked`, `viewing.canceled`, `viewing.upcoming`, `file.processed`, `proposal.pending`, `project.created`, `project.updated`, `unit.status_updated`. |
| `createdSince`  | `string (date-time)` | nein    | Only events at or after this instant (ISO 8601). Events older than 30 days are gone.                                                                                                                                                     |
| `createdBefore` | `string (date-time)` | nein    | Only events before this instant (ISO 8601).                                                                                                                                                                                              |

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

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `EventList`.

### EventList [#eventlist]

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

### Event [#event]

| Feld          | Typ                                                                                                                                                                                                                   | Beschreibung                                                                                                                                                                                                                                                                                         |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`      | `string`                                                                                                                                                                                                              | Immer `event`.                                                                                                                                                                                                                                                                                       |
| `id`          | `string`                                                                                                                                                                                                              | UUID of the event. Also the `webhook-id` header of every delivery of it, so a retry carries the same value.                                                                                                                                                                                          |
| `type`        | `string`                                                                                                                                                                                                              | What happened. The list is open: handle values you do not know by ignoring the event. Eines von `inquiry.received`, `message.received`, `viewing.booked`, `viewing.canceled`, `viewing.upcoming`, `file.processed`, `proposal.pending`, `project.created`, `project.updated`, `unit.status_updated`. |
| `createdAt`   | `string (date-time)`                                                                                                                                                                                                  | When it happened.                                                                                                                                                                                                                                                                                    |
| `apiVersion`  | `string`                                                                                                                                                                                                              | The API version the `data` is shaped in.                                                                                                                                                                                                                                                             |
| `livemode`    | `boolean`                                                                                                                                                                                                             | `true` for an event of the real office, `false` for an event of the test office (test keys). Nothing in a test office leaves Athaus except deliveries to your webhook endpoints.                                                                                                                     |
| `data`        | `object`                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                      |
| `data.object` | `Inquiry \| Message \| Viewing \| File \| Proposal \| ProjectEventObject \| UnitEventObject \| InquiryDeleted \| MessageDeleted \| ViewingDeleted \| FileDeleted \| ProposalDeleted \| ProjectDeleted \| UnitDeleted` | The resource the event is about, as `GET` returns it now, or `{ object, id, deleted: true }` if it is gone.                                                                                                                                                                                          |

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