# List viewings

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

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

Type: Reference
Last updated: 2026-11-14

Returns the booked viewings of the office, earliest first by default, each with its guests. Narrow by listing and by start with `startsFrom` and `startsTo`. A viewing has no time of change, so `updatedSince` is rejected as an unknown parameter; follow bookings by listing a time window with `startsFrom` and `startsTo`. Needs read access to `viewings`.

Requires the scope [`read`](/en/api/v1/anmeldung#scopes) and at least the level `read` on `viewings`.

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

## Request [#request]

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

### Parameters [#parameters]

**Query**

| Name         | Type                 | Required | Description                                                                                        |
| ------------ | -------------------- | -------- | -------------------------------------------------------------------------------------------------- |
| `limit`      | `integer`            | no       | Page size, 1 to 100. More than 100 is rejected, never capped. Default `50`.                        |
| `cursor`     | `string`             | no       | Opaque value from `nextCursor` of the previous page.                                               |
| `listingId`  | `string (uuid)`      | no       | Only viewings at this property.                                                                    |
| `startsFrom` | `string (date-time)` | no       | Only viewings that start at or after this instant (ISO 8601).                                      |
| `startsTo`   | `string (date-time)` | no       | Only viewings that start before this instant (ISO 8601).                                           |
| `sort`       | `string`             | no       | Order by the start. Earliest first by default. One of `startsAt`, `-startsAt`. Default `startsAt`. |

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

## Response [#response]

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

### ViewingList [#viewinglist]

| Field        | Type             | Description                                                   |
| ------------ | ---------------- | ------------------------------------------------------------- |
| `object`     | `string`         | Always `list`.                                                |
| `data`       | `Viewing[]`      |                                                               |
| `hasMore`    | `boolean`        | True if another page follows.                                 |
| `nextCursor` | `string \| null` | Pass as `cursor` to get the next page. Null on the last page. |

### Viewing [#viewing]

| Field                   | Type                 | Description                                                 |
| ----------------------- | -------------------- | ----------------------------------------------------------- |
| `object`                | `string`             | Always `viewing`.                                           |
| `id`                    | `string`             | UUID of the viewing.                                        |
| `listingId`             | `string`             |                                                             |
| `startsAt`              | `string (date-time)` |                                                             |
| `endsAt`                | `string (date-time)` |                                                             |
| `capacity`              | `integer`            | How many guests the viewing takes.                          |
| `attendees`             | `object[]`           |                                                             |
| `attendees[].object`    | `string`             | Always `attendee`.                                          |
| `attendees[].id`        | `string`             |                                                             |
| `attendees[].inquiryId` | `string`             | UUID of the inquiry this guest belongs to.                  |
| `attendees[].name`      | `string`             | First name and the initial of the last name, as in the app. |
| `attendees[].status`    | `string`             | One of `booked`, `attended`, `no_show`, `canceled`.         |
| `attendees[].createdAt` | `string (date-time)` | When the guest booked.                                      |

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