Skip to content

List studio automations

GET
/v1/studios/{studio}/automations
curl --request GET \
--url https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/automations \
--header 'Authorization: Bearer <token>'

Recurring weekly schedules that flip a studio toggle (Busy/DND or AI Screen All) at a local time. Ordered by trigger time.

studio
required
string format: uuid

Studio ID (UUID).

Automations.

Media typeapplication/json
object
automations
required
Array<object>

A recurring studio automation. action_value and enabled are integers (0 / 1). Create and update responses also include the additional columns marked optional below (always null for studio automations, except last_fired_at).

object
guid
required
string
studio_guid
required
string
action
required
string
Allowed values: busy_all screen_all
action_value
required
integer
Allowed values: 0 1
label
required
string
days_mask
required

Weekday bitmask (bit 0 = Sunday … bit 6 = Saturday).

integer
>= 1 <= 127
trigger_minute
required

Local minutes after midnight.

integer
<= 1439
timezone
required

IANA timezone name.

string
enabled
required
integer
Allowed values: 0 1
created_at
required
string
updated_at
required
string
last_fired_at

When the automation last fired (create/update responses only).

string | null
number_guid
null
dest_studio_guid
null
dest_trunk_guid
null
forward_dest_type
null
forward_sip_address
null
forward_phone_number
null

Example

{
"automations": [
{
"action": "busy_all",
"action_value": 0,
"enabled": 0
}
]
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.