AthausDocs

List the messages of an inquiry

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

Last updated:

Returns the conversation of one inquiry, oldest message first by default. Notes of the system, for example about a booked viewing, are part of it. A message has no time of change, so updatedSince is rejected as an unknown parameter; read new messages with sort=-createdAt and stop at the last createdAt you saw. Needs read access to inquiries.

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

Try it in the console

Request

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

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the inquiry.

Query

NameTypeRequiredDescription
limitintegernoPage size, 1 to 100. More than 100 is rejected, never capped. Default 50.
cursorstringnoOpaque value from nextCursor of the previous page.
sortstringnoField to order by. Oldest first by default, as in a conversation. One of createdAt, -createdAt. Default createdAt.

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.

Example

curl "https://api.athaus.ai/v1/inquiries/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17/messages?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with MessageList.

MessageList

FieldTypeDescription
objectstringAlways list.
dataMessage[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

Message

FieldTypeDescription
objectstringAlways message.
idstringUUID of the message.
inquiryIdstring
senderstringseeker wrote it, office wrote it, system is a note of Athaus, for example about a booked viewing. One of seeker, office, system.
textstring
createdAtstring (date-time)

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.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

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

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

Keep reading

On this page