# List files

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

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

Type: Reference
Last updated: 2026-11-14

Returns the metadata of the files attached to the properties of the office, newest first by default. Filter by `listingId`. A file has no time of change, so `updatedSince` is rejected as an unknown parameter; follow new files with `sort=-createdAt` and stop at the last `createdAt` you saw. Needs read access to `files`.

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

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

## Request [#request]

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

### 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 files of this property.                                                                               |
| `sort`      | `string`        | no       | Field to order by. A leading `-` sorts descending. One of `createdAt`, `-createdAt`. Default `-createdAt`. |

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

## Response [#response]

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

### FileList [#filelist]

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

### File [#file]

| Field          | Type                 | Description                                                                             |
| -------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `object`       | `string`             | Always `file`.                                                                          |
| `id`           | `string`             | UUID of the file.                                                                       |
| `listingId`    | `string`             |                                                                                         |
| `kind`         | `string`             | One of `photo`, `floor_plan`, `document`.                                               |
| `documentType` | `string \| null`     | For a document, which paper it is, in the keys the app uses. Null if it was not sorted. |
| `filename`     | `string \| null`     |                                                                                         |
| `mimeType`     | `string \| null`     |                                                                                         |
| `sizeBytes`    | `integer \| null`    |                                                                                         |
| `width`        | `integer \| null`    | In pixels, for an image where it is known.                                              |
| `height`       | `integer \| null`    | In pixels, for an image where it is known.                                              |
| `caption`      | `string \| null`     |                                                                                         |
| `position`     | `integer`            | The order within the property. Position 0 is the cover.                                 |
| `createdAt`    | `string (date-time)` |                                                                                         |

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