GET
/
workflows
/
{workflowId}
/
calls
curl --request GET \
  --url https://prod.featherhq.com/workflows/{workflowId}/calls \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "status": "INITIATED",
      "callStartedAt": "2023-11-07T05:31:56Z",
      "callEndedAt": "2023-11-07T05:31:56Z",
      "callEndedReason": "NO_ANSWER",
      "callDuration": 123,
      "outbound": true,
      "callEndedBy": "USER",
      "firstName": "<string>",
      "lastName": "<string>",
      "phone": "<string>",
      "email": "jsmith@example.com",
      "summary": "<string>",
      "recordingUrl": "<string>",
      "transcript": [
        {
          "id": 123,
          "created_at": "<string>",
          "text": "<string>",
          "user": "<string>"
        }
      ],
      "variables": {},
      "customerLeadId": "<string>",
      "customerMetadata": {},
      "disclosures": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "tag": "SINGLE",
      "workflowId": "<string>",
      "workflowExecutionId": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "nextCursor": {
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
workflowId
string
required

Query Parameters

​
id
string

Cursor for pagination (ID of the last item in previous page)

​
createdAt
string

Cursor for pagination (createdAt of the last item in previous page)

​
limit
string

Number of items per page (default: 25, max: 100)

​
status
enum<string>

Filter by call status

Available options:
INITIATED,
SCHEDULED,
QUEUED,
IN_PROGRESS,
COMPLETED,
FAILED,
CANCELLED
​
callEndedReason
enum<string>

Filter by call ended reason

Available options:
NO_ANSWER,
LEFT_VOICEMAIL,
BAD_NUMBER,
NOT_INTERESTED,
WARM_TRANSFER,
CALENDLY,
DNC,
ENDED,
FRAUD,
LINE_BUSY,
TEXT_CONSENT,
CALL_AGAIN
​
duration
string

Filter by call duration

Response

200
application/json

List of calls for the workflow

The response is of type object.