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.
Request
GET https://api.athaus.ai/v1/eventsParameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size, 1 to 100. More than 100 is rejected, never capped. Default 50. |
cursor | string | no | Opaque value from nextCursor of the previous page. |
type | string | no | Only 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. |
createdSince | string (date-time) | no | Only events at or after this instant (ISO 8601). Events older than 30 days are gone. |
createdBefore | string (date-time) | no | Only events before this instant (ISO 8601). |
Header
| Name | Type | Required | Description |
|---|---|---|---|
Athaus-Version | string | no | 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. |
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
| Field | Type | Description |
|---|---|---|
object | string | Always list. |
data | Event[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
Event
| Field | Type | Description |
|---|---|---|
object | string | Always event. |
id | string | UUID of the event. Also the webhook-id header of every delivery of it, so a retry carries the same value. |
type | string | What 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. |
createdAt | string (date-time) | When it happened. |
apiVersion | string | The API version the data is shaped in. |
livemode | boolean | true 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. |
data | object | |
data.object | Inquiry | Message | Viewing | File | Proposal | ProjectEventObject | UnitEventObject | InquiryDeleted | MessageDeleted | ViewingDeleted | FileDeleted | ProposalDeleted | ProjectDeleted | UnitDeleted | The resource the event is about, as GET returns it now, or { object, id, deleted: true } if it is gone. |
Response headers
| Header | Description |
|---|---|
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. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
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. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.