# List projects

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

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

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Returns the external ids of the office's new-build projects, newest first, with a summary of each. Page with `nextPageToken`; follow changes with `updatedSince`. Needs read access to `projects`.

Braucht den Scope [`read`](/api/v1/anmeldung#scopes) und mindestens die Stufe `read` auf `projects`.

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

## Aufruf [#aufruf]

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

### Parameter [#parameter]

**Abfrage**

| Name            | Typ                  | Pflicht | Beschreibung                                                                |
| --------------- | -------------------- | ------- | --------------------------------------------------------------------------- |
| `limit`         | `integer`            | nein    | Page size, 1 to 100. More than 100 is rejected, never capped. Vorgabe `50`. |
| `nextPageToken` | `string`             | nein    | The `nextPageToken` of the previous page.                                   |
| `updatedSince`  | `string (date-time)` | nein    | Only projects changed at or after this time.                                |

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

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `ProjectIdList`.

### ProjectIdList [#projectidlist]

| Feld                           | Typ                  | Beschreibung                                               |
| ------------------------------ | -------------------- | ---------------------------------------------------------- |
| `externalProjectIds`           | `string[]`           |                                                            |
| `nextPageToken`                | `string \| any`      |                                                            |
| `projects`                     | `object[]`           | Ours, not OpenImmo: a summary of each project in the page. |
| `projects[].projectId`         | `string`             |                                                            |
| `projects[].externalProjectId` | `string`             |                                                            |
| `projects[].status`            | `string \| any`      |                                                            |
| `projects[].updatedAt`         | `string (date-time)` |                                                            |

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