Health
Agents
Agent Version Shareable Links
Configuration
Dispatch
Integrations
Knowledge Base
- GETGet knowledge base collections
- POSTCreate knowledge base collection
- DELDelete knowledge base collection
- GETGet knowledge base files
- POSTCreate knowledge base file
- POSTView knowledge base file
- DELDelete knowledge base file
- PATCHUpdate file status
- POSTGenerate presigned URL for uploading a file
- POSTAdd file to collection
- DELRemove file from collection
Phone Numbers
Testing Lab
Tools
Workflows
- GETList agent workflows
- POSTCreate agent workflow
- GETGet agent workflow
- PATCHUpdate agent workflow
- DELDelete agent workflow
- GETList workflow executions
- POSTCreate workflow execution
- GETGet workflow execution
- PUTUpdate workflow execution
- DELDelete workflow execution
- POSTCancel workflow execution
- POSTCancel workflow execution by lead ID
- POSTPause workflow execution
- POSTResume workflow execution
curl --request GET \
--url https://prod.featherhq.com/api/v1/workflow/{id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"startHour": 123,
"endHour": 123,
"timezone": "<string>",
"workflowSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": false,
"timeRanges": []
},
"sunday": {
"enabled": false,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"definition": {
"steps": [
{
"type": "CALL",
"order": 2,
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delayInSecs": 0,
"finishOn": [],
"leaveVoicemail": false
}
]
},
"createdAt": "<string>",
"updatedAt": "<string>"
}Get agent workflow
Get an agent workflow by ID
curl --request GET \
--url https://prod.featherhq.com/api/v1/workflow/{id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"startHour": 123,
"endHour": 123,
"timezone": "<string>",
"workflowSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": false,
"timeRanges": []
},
"sunday": {
"enabled": false,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"definition": {
"steps": [
{
"type": "CALL",
"order": 2,
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delayInSecs": 0,
"finishOn": [],
"leaveVoicemail": false
}
]
},
"createdAt": "<string>",
"updatedAt": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Agent workflow retrieved successfully
Workflow ID
Workflow name
Workflow description
Organization ID
User ID who created the workflow
Whether the workflow is active
Start hour (0-23) for backward compatibility
End hour (0-23) for backward compatibility
Timezone for workflow execution and schedule interpretation
Workflow schedule - operates in workflow timezone
Show child attributes
Show child attributes
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Global time ranges that apply to all enabled days if day-specific ranges are not set
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Exception dates (holidays, special events, etc.)
Show child attributes
Show child attributes
Date in YYYY-MM-DD format
"2024-12-25"
Whether calls are allowed on this date
Custom time ranges for this exception date
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Reason for the exception (e.g., "Christmas Day")
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": { "enabled": false, "timeRanges": [] },
"sunday": { "enabled": false, "timeRanges": [] }
}TCPA schedule - applies to borrower local timezone
Show child attributes
Show child attributes
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Global time ranges that apply to all enabled days if day-specific ranges are not set
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
State-specific TCPA schedule overrides (e.g., different rules for CA, NY)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
Schedule configuration for a specific day
Show child attributes
Show child attributes
Whether this day is enabled
Time ranges when calls are allowed on this day
Show child attributes
Show child attributes
Start hour (0-23)
0 <= x <= 239
Start minute (0-59)
0 <= x <= 590
End hour (0-23)
0 <= x <= 2317
End minute (0-59)
0 <= x <= 590
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
}Workflow definition
Show child attributes
Show child attributes
Workflow steps
1Show child attributes
Show child attributes
Type of workflow step
CALL, TEXT Order of execution (1-indexed)
x >= 1Agent to use for this step
Delay in seconds before executing this step
x >= 0Call end reasons that should finish the workflow
COULD_NOT_CONNECT, NO_ANSWER, LEFT_VOICEMAIL, VOICEMAIL_DETECTED, SILENCE_TIMEOUT, BAD_NUMBER, NOT_INTERESTED, WARM_TRANSFER, CALENDLY, DNC, ENDED, FRAUD, LINE_BUSY, TEXT_CONSENT, CALL_AGAIN Whether to leave voicemail for call steps
Creation timestamp
Last update timestamp