Skip to main content
GET
Get agent workflow

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Agent workflow retrieved successfully

id
string<uuid>
required

Workflow ID

name
string
required

Workflow name

description
string | null
required

Workflow description

organizationId
string<uuid>
required

Organization ID

userId
string<uuid>
required

User ID who created the workflow

active
boolean
required

Whether the workflow is active

startHour
integer
required

Start hour (0-23) for backward compatibility

endHour
integer
required

End hour (0-23) for backward compatibility

timezone
string
required

Timezone for workflow execution and schedule interpretation

workflowSchedule
object | null
required

Workflow schedule - operates in workflow timezone

Example:
tcpaSchedule
object | null
required

TCPA schedule - applies to borrower local timezone

Example:
definition
object
required

Workflow definition

maxDialsPerTick
integer | null
required

Per-workflow max dials per scheduler tick. null = uncapped (uses shared org budget).

Required range: x >= 1
createdAt
string
required

Creation timestamp

updatedAt
string
required

Last update timestamp