REST API reference
Every operation of /v1 with parameters, response and example, generated from the contract of the API.
Last updated:
Every operation of /v1 has a page. They are generated from the contract that describes the API. The OpenAPI document of the same operations is at https://api.athaus.ai/v1/openapi.json: open without a key, and the address stays.
| Method | Route | Page |
|---|---|---|
GET | /v1/me | Retrieve the calling key and its office |
GET | /v1/health | Check that the API answers |
GET | /v1/listings | List listings |
POST | /v1/listings | Create a listing |
GET | /v1/listings/{externalListingId} | Retrieve a listing |
PATCH | /v1/listings/{externalListingId} | Update a listing |
DELETE | /v1/listings/{externalListingId} | Delete a listing |
PUT | /v1/listings/{externalListingId} | Create or update a listing |
GET | /v1/contacts | List contacts |
POST | /v1/contacts | Create a contact |
GET | /v1/contacts/{id} | Retrieve a contact |
PATCH | /v1/contacts/{id} | Update a contact |
DELETE | /v1/contacts/{id} | Delete a contact |
GET | /v1/inquiries | List inquiries |
GET | /v1/inquiries/{id} | Retrieve an inquiry |
GET | /v1/inquiries/{id}/messages | List the messages of an inquiry |
POST | /v1/inquiries/{id}/messages | Reply to an inquiry |
GET | /v1/viewings | List viewings |
GET | /v1/viewings/{id} | Retrieve a viewing |
GET | /v1/files | List files |
GET | /v1/files/{id} | Retrieve a file |
GET | /v1/files/{id}/content | Download a file |
POST | /v1/medias | Upload a file |
GET | /v1/projects | List projects |
POST | /v1/projects | Create a project |
GET | /v1/projects/{externalProjectId} | Retrieve a project |
PUT | /v1/projects/{externalProjectId} | Create or update a project |
DELETE | /v1/projects/{externalProjectId} | Delete a project |
POST | /v1/projects/{externalProjectId}/units | Create the units of a project |
POST | /v1/projects/{externalProjectId}/assign | Move listings into a project |
POST | /v1/projects/{externalProjectId}/unassign | Release units from a project |
POST | /v1/listings/{externalListingId}/unit-status | Set the status of a unit |
POST | /v1/listings/{externalListingId}/publish | Publish a listing |
POST | /v1/listings/{externalListingId}/unpublish | Take a listing offline |
POST | /v1/inquiries/{id}/followUps | Follow up on an inquiry |
GET | /v1/proposals | List proposals |
GET | /v1/proposals/{id} | Retrieve a proposal |
GET | /v1/automations | List the automation levels of the office |
GET | /v1/automations/{id} | Retrieve an automation level |
GET | /v1/apiKeys | List the API keys of the office |
GET | /v1/apiKeys/{id} | Retrieve an API key |
DELETE | /v1/apiKeys/{id} | Revoke an API key |
GET | /v1/events | List events |
GET | /v1/events/{id} | Retrieve an event |
POST | /v1/webhookEndpoints | Create a webhook endpoint |
GET | /v1/webhookEndpoints | List webhook endpoints |
GET | /v1/webhookEndpoints/{id} | Retrieve a webhook endpoint |
PATCH | /v1/webhookEndpoints/{id} | Update a webhook endpoint |
DELETE | /v1/webhookEndpoints/{id} | Delete a webhook endpoint |
POST | /v1/webhookEndpoints/{id}/rotateSecret | Rotate the signing secret |
POST | /v1/webhookEndpoints/{id}/test | Send a test event |
POST | /v1/proposals/{id}/approve | Approve a proposal |
POST | /v1/proposals/{id}/reject | Reject a proposal |
POST | /v1/test/reset | Reset the test office (test mode) |