Skip to main content
GET
/
api
/
v1
/
workflow
/
{workflowId}
/
execution
/
{executionId}
Get workflow execution
curl --request GET \
  --url https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/{executionId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CREATED",
  "startedAt": "<string>",
  "completedAt": "<string>",
  "customerLeadId": "<string>",
  "primaryPhone": "<string>",
  "metadata": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "disposition": "COULD_NOT_CONNECT",
  "definition": {
    "steps": [
      {
        "type": "CALL",
        "order": 2,
        "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "delayInSecs": 0,
        "finishOn": [],
        "leaveVoicemail": false,
        "initialMessage": "<string>",
        "count": 1
      }
    ],
    "isInfinite": false
  },
  "stepExecutions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflowExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "PENDING",
      "type": "CALL",
      "order": 123,
      "delayInSecs": 123,
      "finishOn": [
        "COULD_NOT_CONNECT"
      ],
      "startedAt": "<string>",
      "completedAt": "<string>",
      "leaveVoicemail": true,
      "disposition": "COULD_NOT_CONNECT",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentCall": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "callStartedAt": "<string>",
        "callEndedAt": "<string>",
        "callDuration": 123,
        "callEndedReason": "COULD_NOT_CONNECT",
        "recordingUrl": "<string>",
        "summary": "<string>"
      }
    }
  ],
  "createdAt": "<string>",
  "variables": {},
  "stepIndex": 123,
  "nextRunAt": "<string>",
  "priorityDate": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
workflowId
string<uuid>
required
​
executionId
string<uuid>
required

Response

Agent workflow execution retrieved successfully

​
id
string<uuid>
required

Execution ID

​
workflowId
string<uuid>
required

Workflow ID

​
status
enum<string>
required

Execution status

Available options:
CREATED,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
PAUSED
​
startedAt
string
required

Execution start timestamp

​
completedAt
string | null
required

Execution completion timestamp

​
customerLeadId
string | null
required

Customer lead identifier

​
primaryPhone
string | null
required

Primary phone number

​
metadata
required

Execution metadata

​
disposition
enum<string> | null
required

Final execution disposition

Available options:
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
​
definition
object
required

Workflow definition snapshot

​
stepExecutions
object[]
required

Step executions

​
createdAt
string
required

Creation timestamp

​
variables
object

Variables for the execution

​
stepIndex
number

Current step index being processed

​
nextRunAt
string | null

Next scheduled run timestamp

​
priorityDate
string | null

Lead priority date