AthausDocs

Retrieve a viewing

Request, parameters, response and errors of GET /v1/viewings/{id}.

Last updated:

Requires the scope read and at least the level read on viewings.

Try it in the console

Request

GET https://api.athaus.ai/v1/viewings/{id}

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the viewing.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional 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.
If-None-MatchstringnoAn ETag you hold. If it is still current, the answer is 304 without a body.

Example

curl "https://api.athaus.ai/v1/viewings/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with Viewing.

Viewing

FieldTypeDescription
objectstringAlways viewing.
idstringUUID of the viewing.
listingIdstring
startsAtstring (date-time)
endsAtstring (date-time)
capacityintegerHow many guests the viewing takes.
attendeesobject[]
attendees[].objectstringAlways 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[].statusstringOne of booked, attended, no_show, canceled.
attendees[].createdAtstring (date-time)When the guest booked.

Response headers

HeaderDescription
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.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

With If-None-Match naming the current ETag, the operation answers 304 without a body.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400invalid_id, api_version_unsupported, invalid_inputInvalid 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.

Keep reading

On this page