List the automation levels of the office
Request, parameters, response and errors of GET /v1/automations.
Last updated:
Returns, for every kind of action, how much Athaus does without a yes: off, ask (prepare it and wait for a person) or auto. The same levels the office sets in the app under Automatik, and the ones that decide whether POST /inquiries/{id}/messages answers 201 or 202. The list is short and complete, so there is no paging: hasMore is always false. A test key sees the levels of its test office. Needs read access to inquiries.
Requires the scope read.
Request
GET https://api.athaus.ai/v1/automationsParameters
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/automations" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 200 with AutomationList.
AutomationList
| Field | Type | Description |
|---|---|---|
object | string | Always list. |
data | Automation[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
Automation
| Field | Type | Description |
|---|---|---|
object | string | Always automation. |
id | string | The kind of action, in the same words as the kind of the MCP tool update_automation. The list is open: new kinds arrive. One of 24 values from the list in the standard. |
level | string | off: Athaus prepares nothing. ask: Athaus prepares it and waits for a yes. auto: Athaus does it without a yes. One of off, ask, auto. |
allowedLevels | string[] | The levels this kind may have. A kind that reaches people never allows auto for some actions. One of off, ask, auto. |
isDefault | boolean | true while nobody in the office has set the level; the default applies. |
goesOut | boolean | true if the action reaches a person outside the office. |
livemode | boolean | false for the test office of a test key. |
updatedAt | string (date-time) | null | When the level was last set. Null while it is the default. |
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 | 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.