# Retrieve a project

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

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

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Returns the project in the OpenImmo 2.0 shape. `data.units` carries the figures of its units (their number, price and area range); the units themselves are listings, named by `assignedListings` (ours, not OpenImmo; a project holds at most 1000 units, so the list is never longer) and readable with `GET /listings/{externalListingId}`, where `projectId` marks them. 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=getProject)

## Aufruf [#aufruf]

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

### Parameter [#parameter]

**Pfad**

| Name                | Typ      | Pflicht | Beschreibung                                                                                                                                                                                                                                                              |
| ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `externalProjectId` | `string` | ja      | Your reference of the project: the value of metadata.source.offererMarketingKey. A project without one has its own projectId here, and the projectId always works in the path. 1 to 128 letters, digits, dots, underscores or hyphens, not starting or ending with a dot. |

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

### Beispiel [#beispiel]

```bash
curl "https://api.athaus.ai/v1/projects/PRJ-1-ext" \
  -H "Authorization: Bearer ath_live_..."
```

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `ProjectResponse`.

### ProjectResponse [#projectresponse]

| Feld                                                        | Typ                               | Beschreibung                                                                            |
| ----------------------------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------- |
| `projectId`                                                 | `string (uuid)`                   | Ours, not OpenImmo: the id Athaus gave the project; it always works in the path.        |
| `status`                                                    | `string \| any`                   | Ours, not OpenImmo: the project state of the office, by name.                           |
| `createdAt`                                                 | `string (date-time)`              |                                                                                         |
| `updatedAt`                                                 | `string (date-time)`              |                                                                                         |
| `data`                                                      | `object`                          |                                                                                         |
| `data.estateType`                                           | `string`                          | Eines von `NEW_BUILD_PROJECT`, `NEW_HOME_PROJECT`.                                      |
| `data.estateSubType`                                        | `string \| object \| null \| any` |                                                                                         |
| `data.distributionType`                                     | `string`                          | Eines von `BUY`, `RENT`, `BUY_RENT`.                                                    |
| `data.units`                                                | `object`                          |                                                                                         |
| `data.units.numberOfUnits`                                  | `number`                          | 0 bis 999999.                                                                           |
| `data.units.priceFrom`                                      | `number`                          | 0 bis .                                                                                 |
| `data.units.priceTo`                                        | `number`                          | 0 bis .                                                                                 |
| `data.units.livingSpaceFrom`                                | `number`                          | 0 bis .                                                                                 |
| `data.units.livingSpaceTo`                                  | `number`                          | 0 bis .                                                                                 |
| `data.units.numberOfRoomsFrom`                              | `number`                          | 0 bis .                                                                                 |
| `data.units.numberOfRoomsTo`                                | `number`                          | 0 bis .                                                                                 |
| `data.units.furnishingLevel`                                | `string`                          | Eines von `NOT_PROVIDED`, `STANDARD`, `UPSCALE`, `FULL`.                                |
| `data.units.provisionType`                                  | `string`                          | Eines von `PROVISION_FREE`, `PROVISION_FOR_BUYER`, `NOT_PROVIDED`.                      |
| `data.units.provisionPercent`                               | `number`                          | 0 bis .                                                                                 |
| `data.units.provisionIsVatIncluded`                         | `string`                          | Eines von `YES`, `NO`, `NOT_PROVIDED`.                                                  |
| `data.units.soldOutPercentage`                              | `number`                          | 0 bis .                                                                                 |
| `data.location`                                             | `object`                          |                                                                                         |
| `data.location.postalcode`                                  | `string`                          |                                                                                         |
| `data.location.city`                                        | `string`                          |                                                                                         |
| `data.location.street`                                      | `string`                          |                                                                                         |
| `data.location.houseNumber`                                 | `string`                          |                                                                                         |
| `data.location.unit`                                        | `string`                          |                                                                                         |
| `data.location.staircase`                                   | `string`                          |                                                                                         |
| `data.location.floorNumber`                                 | `integer`                         | -5 bis 999.                                                                             |
| `data.location.entrance`                                    | `string`                          |                                                                                         |
| `data.location.state`                                       | `string`                          |                                                                                         |
| `data.location.country`                                     | `string`                          | Eine von 249 Angaben der Liste im Standard.                                             |
| `data.location.geometry`                                    | `object`                          |                                                                                         |
| `data.location.geometry.type`                               | `string`                          | Immer `Point`.                                                                          |
| `data.location.geometry.coordinates`                        | `number[]`                        |                                                                                         |
| `data.location.showAddress`                                 | `boolean`                         | Vorgabe `true`.                                                                         |
| `data.location.locationNote`                                | `map<string>`                     |                                                                                         |
| `data.program`                                              | `object`                          |                                                                                         |
| `data.program.projectStatus`                                | `string`                          | Eines von `CONSTRUCTION_START`, `PROJECT_ENDED`.                                        |
| `data.deliveryDate`                                         | `string`                          |                                                                                         |
| `data.structure`                                            | `object`                          |                                                                                         |
| `data.structure.building`                                   | `object`                          |                                                                                         |
| `data.structure.building.numberOfFloors`                    | `integer`                         | 1 bis 999.                                                                              |
| `data.texts`                                                | `object`                          |                                                                                         |
| `data.texts.headline`                                       | `map<string>`                     |                                                                                         |
| `data.texts.description`                                    | `map<string>`                     |                                                                                         |
| `data.texts.features`                                       | `map<string>`                     |                                                                                         |
| `data.texts.extendedInformation`                            | `map<string>`                     |                                                                                         |
| `data.texts.area`                                           | `map<string>`                     |                                                                                         |
| `data.links`                                                | `object`                          |                                                                                         |
| `data.links.externalLinks`                                  | `object[]`                        |                                                                                         |
| `data.links.externalLinks[].url`                            | `string`                          |                                                                                         |
| `data.links.externalLinks[].urlType`                        | `string`                          | Eines von `MAP`, `MOVIE`, `PANORAMA`, `REVOCATION_INSTRUCTION`, `OFFERER_DETAIL_PAGE`.  |
| `data.links.externalLinks[].title`                          | `string`                          |                                                                                         |
| `data.links.virtualTours`                                   | `object[]`                        |                                                                                         |
| `data.links.virtualTours[].url`                             | `string`                          |                                                                                         |
| `data.links.virtualTours[].provider`                        | `string`                          |                                                                                         |
| `data.links.virtualTours[].title`                           | `string`                          |                                                                                         |
| `data.contact`                                              | `object`                          |                                                                                         |
| `data.contact.salutation`                                   | `string`                          | Eines von `Mr`, `Mrs`, `Miss`, `Ms`, `Mx`, `Sir`, `Dame`, `Dr`, `Cllr`, `Lady`, `Lord`. |
| `data.contact.firstName`                                    | `string`                          |                                                                                         |
| `data.contact.lastName`                                     | `string`                          |                                                                                         |
| `data.contact.name`                                         | `string`                          |                                                                                         |
| `data.contact.emailAddress`                                 | `string`                          |                                                                                         |
| `data.contact.phoneNumber`                                  | `string`                          |                                                                                         |
| `data.contact.mobilePhoneNumber`                            | `string`                          |                                                                                         |
| `data.contact.imageURL`                                     | `string`                          |                                                                                         |
| `data.contact.userHomepage`                                 | `string`                          |                                                                                         |
| `data.contact.postalCode`                                   | `string`                          |                                                                                         |
| `data.contact.city`                                         | `string`                          |                                                                                         |
| `data.contact.street`                                       | `string`                          |                                                                                         |
| `data.contact.houseNumber`                                  | `string`                          |                                                                                         |
| `data.contact.country`                                      | `string`                          |                                                                                         |
| `data.contact.preferredContactType`                         | `string`                          | Eines von `ANONYMOUS`, `BY_PHONE`, `BY_EMAIL`, `OWN_WEBSITE`.                           |
| `data.contact.contactNote`                                  | `map<string>`                     |                                                                                         |
| `data.contact.displayedInformation`                         | `object`                          |                                                                                         |
| `data.contact.displayedInformation.mainContactPerson`       | `object`                          |                                                                                         |
| `data.contact.displayedInformation.additionalContactPerson` | `object`                          |                                                                                         |
| `metadata`                                                  | `object`                          |                                                                                         |
| `metadata.source`                                           | `object`                          |                                                                                         |
| `metadata.source.offererMarketingKey`                       | `string`                          |                                                                                         |
| `metadata.source.offererEstateId`                           | `string`                          |                                                                                         |
| `metadata.portalWebKey`                                     | `string`                          |                                                                                         |
| `assignedListings`                                          | `object[]`                        |                                                                                         |
| `assignedListings[].externalListingId`                      | `string`                          |                                                                                         |

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

Mit `If-None-Match` auf den aktuellen `ETag` antwortet die Operation `304` ohne Rumpf.

## Fehler [#fehler]

Jeder Fehler kommt als [Problem Details](/api/v1/fehler). Verzweige auf `code`, nicht auf `title` oder `detail`.

| Status | Codes                                                                                                            | Bedeutung                                                       |
| ------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| `400`  | [`api_version_unsupported`](/api/errors#api_version_unsupported), [`invalid_input`](/api/errors#invalid_input)   | 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.                                                   |
