AthausDocs

List events

Request, parameters, response and errors of GET /v1/events.

Last updated:

Returns what happened in the office during the last 30 days, newest first: new inquiries and messages, booked, cancelled and upcoming viewings, processed files. Filter by type and by time with createdSince and createdBefore. A key sees only the events of the resources it may read; asking for a type outside that is a 403. data.object is the resource as GET returns it now, not as it was when the event happened. Needs the right lesen.

Requires the scope read.

Try it in the console

Request

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

Parameters

Query

NameTypeRequiredDescription
limitintegernoPage size, 1 to 100. More than 100 is rejected, never capped. Default 50.
cursorstringnoOpaque value from nextCursor of the previous page.
typestringnoOnly events of this type. One of inquiry.received, message.received, viewing.booked, viewing.canceled, viewing.upcoming, file.processed, proposal.pending, project.created, project.updated, unit.status_updated.
createdSincestring (date-time)noOnly events at or after this instant (ISO 8601). Events older than 30 days are gone.
createdBeforestring (date-time)noOnly events before this instant (ISO 8601).

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/events?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with EventList.

EventList

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

Event

FieldTypeDescription
objectstringAlways event.
idstringUUID of the event. Also the webhook-id header of every delivery of it, so a retry carries the same value.
typestringWhat happened. The list is open: handle values you do not know by ignoring the event. One of inquiry.received, message.received, viewing.booked, viewing.canceled, viewing.upcoming, file.processed, proposal.pending, project.created, project.updated, unit.status_updated.
createdAtstring (date-time)When it happened.
apiVersionstringThe API version the data is shaped in.
livemodebooleantrue for an event of the real office, false for an event of the test office (test keys). Nothing in a test office leaves Athaus except deliveries to your webhook endpoints.
dataobject
data.objectInquiry | Message | Viewing | File | Proposal | ProjectEventObject | UnitEventObject | InquiryDeleted | MessageDeleted | ViewingDeleted | FileDeleted | ProposalDeleted | ProjectDeleted | UnitDeletedThe resource the event is about, as GET returns it now, or { object, id, deleted: true } if it is gone.

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, 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