Retrieve an event
Request, parameters, response and errors of GET /v1/events/{id}.
Last updated:
Returns one event, if it is at most 30 days old and belongs to a resource the key may read; otherwise 404. Needs the right lesen.
Requires the scope read.
Request
GET https://api.athaus.ai/v1/events/{id}Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | UUID of the event. |
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. |
If-None-Match | string | no | An ETag you hold. If it is still current, the answer is 304 without a body. |
Example
curl "https://api.athaus.ai/v1/events/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 200 with Event.
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. |
ETag | A 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-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining 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.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_id, api_version_unsupported, invalid_input | 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.