List viewings
Aufruf, Parameter, Antwort und Fehler von GET /v1/viewings.
Zuletzt aktualisiert:
Returns the booked viewings of the office, earliest first by default, each with its guests. Narrow by listing and by start with startsFrom and startsTo. A viewing has no time of change, so updatedSince is rejected as an unknown parameter; follow bookings by listing a time window with startsFrom and startsTo. Needs read access to viewings.
Braucht den Scope read und mindestens die Stufe read auf viewings.
Aufruf
GET https://api.athaus.ai/v1/viewingsParameter
Abfrage
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
limit | integer | nein | Page size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50. |
cursor | string | nein | Opaque value from nextCursor of the previous page. |
listingId | string (uuid) | nein | Only viewings at this property. |
startsFrom | string (date-time) | nein | Only viewings that start at or after this instant (ISO 8601). |
startsTo | string (date-time) | nein | Only viewings that start before this instant (ISO 8601). |
sort | string | nein | Order by the start. Earliest first by default. Eines von startsAt, -startsAt. Vorgabe startsAt. |
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
curl "https://api.athaus.ai/v1/viewings?limit=10" \
-H "Authorization: Bearer ath_live_..."Antwort
Bei Erfolg kommt 200 mit ViewingList.
ViewingList
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer list. |
data | Viewing[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
Viewing
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer viewing. |
id | string | UUID of the viewing. |
listingId | string | |
startsAt | string (date-time) | |
endsAt | string (date-time) | |
capacity | integer | How many guests the viewing takes. |
attendees | object[] | |
attendees[].object | string | Immer attendee. |
attendees[].id | string | |
attendees[].inquiryId | string | UUID of the inquiry this guest belongs to. |
attendees[].name | string | First name and the initial of the last name, as in the app. |
attendees[].status | string | Eines von booked, attended, no_show, canceled. |
attendees[].createdAt | string (date-time) | When the guest booked. |
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
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | invalid_query, api_version_unsupported | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.