AthausDocs

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.

Try it in the console

Request

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

Parameters

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/automations" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with AutomationList.

AutomationList

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

Automation

FieldTypeDescription
objectstringAlways automation.
idstringThe 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.
levelstringoff: Athaus prepares nothing. ask: Athaus prepares it and waits for a yes. auto: Athaus does it without a yes. One of off, ask, auto.
allowedLevelsstring[]The levels this kind may have. A kind that reaches people never allows auto for some actions. One of off, ask, auto.
isDefaultbooleantrue while nobody in the office has set the level; the default applies.
goesOutbooleantrue if the action reaches a person outside the office.
livemodebooleanfalse for the test office of a test key.
updatedAtstring (date-time) | nullWhen the level was last set. Null while it is the default.

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
400api_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