# REST-API Referenz

Adresse: https://docs.athaus.ai/api/v1/referenz

> Jede Operation von /v1 mit Parametern, Antwort und Beispiel, aus dem Vertrag der API erzeugt.

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Jede Operation von `/v1` hat eine Seite. Sie entstehen aus dem Vertrag der API. Die Texte der Felder sind englisch, wie die API selbst. Das OpenAPI-Dokument derselben Operationen liegt unter `https://api.athaus.ai/v1/openapi.json`, ohne Key abrufbar und unter dieser Adresse beständig.

| Methode  | Weg                                            | Seite                                                                         |
| -------- | ---------------------------------------------- | ----------------------------------------------------------------------------- |
| `GET`    | `/v1/me`                                       | [Retrieve the calling key and its office](/api/v1/referenz/get-me)            |
| `GET`    | `/v1/health`                                   | [Check that the API answers](/api/v1/referenz/get-health)                     |
| `GET`    | `/v1/listings`                                 | [List listings](/api/v1/referenz/list-listings)                               |
| `POST`   | `/v1/listings`                                 | [Create a listing](/api/v1/referenz/create-listing)                           |
| `GET`    | `/v1/listings/{externalListingId}`             | [Retrieve a listing](/api/v1/referenz/get-listing)                            |
| `PATCH`  | `/v1/listings/{externalListingId}`             | [Update a listing](/api/v1/referenz/patch-listing)                            |
| `DELETE` | `/v1/listings/{externalListingId}`             | [Delete a listing](/api/v1/referenz/delete-listing)                           |
| `PUT`    | `/v1/listings/{externalListingId}`             | [Create or update a listing](/api/v1/referenz/replace-listing)                |
| `GET`    | `/v1/contacts`                                 | [List contacts](/api/v1/referenz/list-contacts)                               |
| `POST`   | `/v1/contacts`                                 | [Create a contact](/api/v1/referenz/create-contact)                           |
| `GET`    | `/v1/contacts/{id}`                            | [Retrieve a contact](/api/v1/referenz/get-contact)                            |
| `PATCH`  | `/v1/contacts/{id}`                            | [Update a contact](/api/v1/referenz/update-contact)                           |
| `DELETE` | `/v1/contacts/{id}`                            | [Delete a contact](/api/v1/referenz/delete-contact)                           |
| `GET`    | `/v1/inquiries`                                | [List inquiries](/api/v1/referenz/list-inquiries)                             |
| `GET`    | `/v1/inquiries/{id}`                           | [Retrieve an inquiry](/api/v1/referenz/get-inquiry)                           |
| `GET`    | `/v1/inquiries/{id}/messages`                  | [List the messages of an inquiry](/api/v1/referenz/list-inquiry-messages)     |
| `POST`   | `/v1/inquiries/{id}/messages`                  | [Reply to an inquiry](/api/v1/referenz/create-inquiry-message)                |
| `GET`    | `/v1/viewings`                                 | [List viewings](/api/v1/referenz/list-viewings)                               |
| `GET`    | `/v1/viewings/{id}`                            | [Retrieve a viewing](/api/v1/referenz/get-viewing)                            |
| `GET`    | `/v1/files`                                    | [List files](/api/v1/referenz/list-files)                                     |
| `GET`    | `/v1/files/{id}`                               | [Retrieve a file](/api/v1/referenz/get-file)                                  |
| `GET`    | `/v1/files/{id}/content`                       | [Download a file](/api/v1/referenz/get-file-content)                          |
| `POST`   | `/v1/medias`                                   | [Upload a file](/api/v1/referenz/create-media)                                |
| `GET`    | `/v1/projects`                                 | [List projects](/api/v1/referenz/list-projects)                               |
| `POST`   | `/v1/projects`                                 | [Create a project](/api/v1/referenz/create-project)                           |
| `GET`    | `/v1/projects/{externalProjectId}`             | [Retrieve a project](/api/v1/referenz/get-project)                            |
| `PUT`    | `/v1/projects/{externalProjectId}`             | [Create or update a project](/api/v1/referenz/replace-project)                |
| `DELETE` | `/v1/projects/{externalProjectId}`             | [Delete a project](/api/v1/referenz/delete-project)                           |
| `POST`   | `/v1/projects/{externalProjectId}/units`       | [Create the units of a project](/api/v1/referenz/create-project-units)        |
| `POST`   | `/v1/projects/{externalProjectId}/assign`      | [Move listings into a project](/api/v1/referenz/assign-project-listings)      |
| `POST`   | `/v1/projects/{externalProjectId}/unassign`    | [Release units from a project](/api/v1/referenz/unassign-project-listings)    |
| `POST`   | `/v1/listings/{externalListingId}/unit-status` | [Set the status of a unit](/api/v1/referenz/set-unit-status)                  |
| `POST`   | `/v1/listings/{externalListingId}/publish`     | [Publish a listing](/api/v1/referenz/publish-listing)                         |
| `POST`   | `/v1/listings/{externalListingId}/unpublish`   | [Take a listing offline](/api/v1/referenz/unpublish-listing)                  |
| `POST`   | `/v1/inquiries/{id}/followUps`                 | [Follow up on an inquiry](/api/v1/referenz/create-inquiry-follow-up)          |
| `GET`    | `/v1/proposals`                                | [List proposals](/api/v1/referenz/list-proposals)                             |
| `GET`    | `/v1/proposals/{id}`                           | [Retrieve a proposal](/api/v1/referenz/get-proposal)                          |
| `GET`    | `/v1/automations`                              | [List the automation levels of the office](/api/v1/referenz/list-automations) |
| `GET`    | `/v1/automations/{id}`                         | [Retrieve an automation level](/api/v1/referenz/get-automation)               |
| `GET`    | `/v1/apiKeys`                                  | [List the API keys of the office](/api/v1/referenz/list-api-keys)             |
| `GET`    | `/v1/apiKeys/{id}`                             | [Retrieve an API key](/api/v1/referenz/get-api-key)                           |
| `DELETE` | `/v1/apiKeys/{id}`                             | [Revoke an API key](/api/v1/referenz/revoke-api-key)                          |
| `GET`    | `/v1/events`                                   | [List events](/api/v1/referenz/list-events)                                   |
| `GET`    | `/v1/events/{id}`                              | [Retrieve an event](/api/v1/referenz/get-event)                               |
| `POST`   | `/v1/webhookEndpoints`                         | [Create a webhook endpoint](/api/v1/referenz/create-webhook-endpoint)         |
| `GET`    | `/v1/webhookEndpoints`                         | [List webhook endpoints](/api/v1/referenz/list-webhook-endpoints)             |
| `GET`    | `/v1/webhookEndpoints/{id}`                    | [Retrieve a webhook endpoint](/api/v1/referenz/get-webhook-endpoint)          |
| `PATCH`  | `/v1/webhookEndpoints/{id}`                    | [Update a webhook endpoint](/api/v1/referenz/update-webhook-endpoint)         |
| `DELETE` | `/v1/webhookEndpoints/{id}`                    | [Delete a webhook endpoint](/api/v1/referenz/delete-webhook-endpoint)         |
| `POST`   | `/v1/webhookEndpoints/{id}/rotateSecret`       | [Rotate the signing secret](/api/v1/referenz/rotate-webhook-endpoint-secret)  |
| `POST`   | `/v1/webhookEndpoints/{id}/test`               | [Send a test event](/api/v1/referenz/test-webhook-endpoint)                   |
| `POST`   | `/v1/proposals/{id}/approve`                   | [Approve a proposal](/api/v1/referenz/approve-proposal)                       |
| `POST`   | `/v1/proposals/{id}/reject`                    | [Reject a proposal](/api/v1/referenz/reject-proposal)                         |
| `POST`   | `/v1/test/reset`                               | [Reset the test office (test mode)](/api/v1/referenz/reset-test-office)       |
