Skip to content

List Work Routines

GET
/work/routines

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

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

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
deliveryConversationId
Any of:
string
enabled
Any of:
boolean
id
Any of:
string
instruction
Any of:
string
lastRunAt
Any of:
string
lastStatus
Any of:
string
localTime
Any of:
string
timezone
Any of:
string
title
Any of:
string
triggerKind
Any of:
string
weekdays
Any of:
Array<integer>
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string