Skip to main content
GET
Get an automation rule

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

automationRuleId
integer
required

The id returned when the automation rule was listed.

Example:

9

Response

The automation rule.

An automation rule of the account — administrator only on every operation of this group.

id
integer
required
Example:

9

name
string
required
Example:

"Auto-close stale conversations"

description
string | null
required
Example:

"Closes conversations idle for 7 days."

event_name
string
required

The event that triggers evaluation, e.g. conversation_created, conversation_updated.

Example:

"conversation_updated"

active
boolean
required
Example:

true

order_id
integer
required

Execution order among the account's automation rules for the same event, ascending. This is what sort=execution_order (the default) orders by.

Example:

1

conditions
any[]
required

The rule's condition set, in the same shape the dashboard's automation editor writes.

actions
any[]
required

The rule's action set, in the same shape the dashboard's automation editor writes.

created_at
string<date-time>
required
Example:

"2026-05-02T11:04:17.000Z"

updated_at
string<date-time>
required
Example:

"2026-08-10T14:32:05.123Z"