AthausDoku

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.

In der Konsole ausprobieren

Aufruf

GET https://api.athaus.ai/v1/viewings

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
cursorstringneinOpaque value from nextCursor of the previous page.
listingIdstring (uuid)neinOnly viewings at this property.
startsFromstring (date-time)neinOnly viewings that start at or after this instant (ISO 8601).
startsTostring (date-time)neinOnly viewings that start before this instant (ISO 8601).
sortstringneinOrder by the start. Earliest first by default. Eines von startsAt, -startsAt. Vorgabe startsAt.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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

FeldTypBeschreibung
objectstringImmer list.
dataViewing[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

Viewing

FeldTypBeschreibung
objectstringImmer viewing.
idstringUUID of the viewing.
listingIdstring
startsAtstring (date-time)
endsAtstring (date-time)
capacityintegerHow many guests the viewing takes.
attendeesobject[]
attendees[].objectstringImmer attendee.
attendees[].idstring
attendees[].inquiryIdstringUUID of the inquiry this guest belongs to.
attendees[].namestringFirst name and the initial of the last name, as in the app.
attendees[].statusstringEines von booked, attended, no_show, canceled.
attendees[].createdAtstring (date-time)When the guest booked.

Köpfe der Antwort

KopfBeschreibung
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_query, api_version_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite