Health
Workflow Executions
Get Workflow Executions
GET
/
workflows
/
{workflowId}
/
executions
Copy
curl --request GET \
--url https://prod.featherhq.com/workflows/{workflowId}/executions \
--header 'x-api-key: <api-key>'
Copy
{
"data": [
{
"id": "<string>",
"workflowId": "<string>",
"status": "CREATED",
"temporalWorkflowId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"steps": [
{
"id": "<string>",
"workflowExecutionId": "<string>",
"type": "CALL",
"order": 123,
"delayInSecs": 123,
"status": "PENDING",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"result": "<any>",
"error": "<string>",
"callId": "<string>",
"call": {
"id": "<string>",
"status": "INITIATED",
"callStartedAt": "2023-11-07T05:31:56Z",
"callEndedAt": "2023-11-07T05:31:56Z",
"callEndedReason": "NO_ANSWER"
},
"needsTCPACompliance": true,
"finishOn": [
"NO_ANSWER"
],
"voicemailMessage": "<string>"
}
],
"metadata": {
"leadId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"primaryPhone": "<string>",
"zipcode": "<string>",
"referenceURL": "<string>",
"city": "<string>",
"state": "<string>",
"sourceID": "<string>",
"campaignID": "<string>",
"phoneAgentExtension": "<string>",
"phoneAgentDirectDial": "<string>",
"borrowerState": "AL",
"forwardingPhoneNumber": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"receivedCallBack": false,
"callBackCallId": "<string>",
"phoneNumberId": "<string>"
}
],
"pagination": {
"limit": 123,
"nextCursor": {
"id": "<string>",
"createdAt": "<string>"
}
}
}
Authorizations
Path Parameters
Query Parameters
Cursor for pagination (ID of the last item in previous page)
Cursor for pagination (ID of the last item in previous page)
Number of items per page (default: 25, max: 100)
Response
200
application/json
List of workflow executions
The response is of type object
.
Copy
curl --request GET \
--url https://prod.featherhq.com/workflows/{workflowId}/executions \
--header 'x-api-key: <api-key>'
Copy
{
"data": [
{
"id": "<string>",
"workflowId": "<string>",
"status": "CREATED",
"temporalWorkflowId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"steps": [
{
"id": "<string>",
"workflowExecutionId": "<string>",
"type": "CALL",
"order": 123,
"delayInSecs": 123,
"status": "PENDING",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"result": "<any>",
"error": "<string>",
"callId": "<string>",
"call": {
"id": "<string>",
"status": "INITIATED",
"callStartedAt": "2023-11-07T05:31:56Z",
"callEndedAt": "2023-11-07T05:31:56Z",
"callEndedReason": "NO_ANSWER"
},
"needsTCPACompliance": true,
"finishOn": [
"NO_ANSWER"
],
"voicemailMessage": "<string>"
}
],
"metadata": {
"leadId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"primaryPhone": "<string>",
"zipcode": "<string>",
"referenceURL": "<string>",
"city": "<string>",
"state": "<string>",
"sourceID": "<string>",
"campaignID": "<string>",
"phoneAgentExtension": "<string>",
"phoneAgentDirectDial": "<string>",
"borrowerState": "AL",
"forwardingPhoneNumber": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"receivedCallBack": false,
"callBackCallId": "<string>",
"phoneNumberId": "<string>"
}
],
"pagination": {
"limit": 123,
"nextCursor": {
"id": "<string>",
"createdAt": "<string>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.