List Work Routines

GET

/work/routines

• Production
• QA

Every routine in this organization’s workspace, with its recent run activity.

A routine is a standing instruction to an agent, delivered into one conversation, on a schedule or on an event. 503 when the workspace has never been provisioned to hold routines — nothing the caller sent is wrong.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

Every routine in this organization’s workspace.

object

routines

Routines, with recent event activity folded in

Array<object>

One scheduled or event-triggered Work routine.

object

agentId

Any of:

string

string

null

null

deliveryConversationId

Any of:

string

string

null

null

enabled

Any of:

boolean

boolean

null

null

id

Any of:

string

string

null

null

instruction

Any of:

string

string

null

null

lastRunAt

Any of:

string

string

null

null

lastStatus

Any of:

string

string

null

null

localTime

Any of:

string

string

null

null

timezone

Any of:

string

string

null

null

title

Any of:

string

string

null

null

triggerKind

Any of:

string

string

null

null

weekdays

Any of:

Array<integer>

Array<integer>

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string