AthausDoku

REST-API Referenz

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

Zuletzt aktualisiert:

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.

MethodeWegSeite
GET/v1/meRetrieve the calling key and its office
GET/v1/healthCheck that the API answers
GET/v1/listingsList listings
POST/v1/listingsCreate 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/contactsList contacts
POST/v1/contactsCreate 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/inquiriesList inquiries
GET/v1/inquiries/{id}Retrieve an inquiry
GET/v1/inquiries/{id}/messagesList the messages of an inquiry
POST/v1/inquiries/{id}/messagesReply to an inquiry
GET/v1/viewingsList viewings
GET/v1/viewings/{id}Retrieve a viewing
GET/v1/filesList files
GET/v1/files/{id}Retrieve a file
GET/v1/files/{id}/contentDownload a file
POST/v1/mediasUpload a file
GET/v1/projectsList projects
POST/v1/projectsCreate 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}/unitsCreate the units of a project
POST/v1/projects/{externalProjectId}/assignMove listings into a project
POST/v1/projects/{externalProjectId}/unassignRelease units from a project
POST/v1/listings/{externalListingId}/unit-statusSet the status of a unit
POST/v1/listings/{externalListingId}/publishPublish a listing
POST/v1/listings/{externalListingId}/unpublishTake a listing offline
POST/v1/inquiries/{id}/followUpsFollow up on an inquiry
GET/v1/proposalsList proposals
GET/v1/proposals/{id}Retrieve a proposal
GET/v1/automationsList the automation levels of the office
GET/v1/automations/{id}Retrieve an automation level
GET/v1/apiKeysList the API keys of the office
GET/v1/apiKeys/{id}Retrieve an API key
DELETE/v1/apiKeys/{id}Revoke an API key
GET/v1/eventsList events
GET/v1/events/{id}Retrieve an event
POST/v1/webhookEndpointsCreate a webhook endpoint
GET/v1/webhookEndpointsList 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}/rotateSecretRotate the signing secret
POST/v1/webhookEndpoints/{id}/testSend a test event
POST/v1/proposals/{id}/approveApprove a proposal
POST/v1/proposals/{id}/rejectReject a proposal
POST/v1/test/resetReset the test office (test mode)