# Retrieve a file

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

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

Type: Reference
Last updated: 2026-11-14

Returns the metadata of one file. The bytes come from `GET /files/{id}/content`. 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=getFile)

## Request [#request]

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

### Parameters [#parameters]

**Path**

| Name | Type            | Required | Description       |
| ---- | --------------- | -------- | ----------------- |
| `id` | `string (uuid)` | yes      | UUID of the file. |

**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`. |
| `If-None-Match`  | `string` | no       | An ETag you hold. If it is still current, the answer is 304 without a body.                                                                                  |

### Example [#example]

```bash
curl "https://api.athaus.ai/v1/files/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."
```

## Response [#response]

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

### 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.                                                                         |
| `ETag`             | A strong entity tag of this state of the resource. Send it as `If-Match` to change or delete the resource only if it is unchanged, or as `If-None-Match` to read it only if it changed. |
| `RateLimit-Policy` | The quota policy of the bucket that applies.                                                                                                                                            |
| `RateLimit`        | Remaining quota and seconds until the bucket is full again.                                                                                                                             |

With `If-None-Match` naming the current `ETag`, the operation answers `304` without a body.

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