GET
/
workflows
curl --request GET \
  --url https://prod.featherhq.com/workflows \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "active": true,
      "promptId": "<string>",
      "steps": [
        {
          "id": "<string>",
          "type": "CALL",
          "order": 123,
          "needsTCPACompliance": true,
          "delayInSecs": 0,
          "workflowId": "<string>",
          "finishOn": [
            "NO_ANSWER"
          ],
          "textMessage": "<string>",
          "voicemailMessage": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "tag": "ORIGINATION",
      "numberOfAgents": 123,
      "startHour": 123,
      "endHour": 123,
      "timezone": "<string>",
      "totalCalls": 123,
      "voiceId": "<string>",
      "stats": {
        "workflowId": "<string>",
        "promisesTaken": "<string>",
        "cashCollected": "<string>",
        "totalLeads": 123,
        "totalLeadsCompleted": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "phoneNumber": {
        "id": "<string>",
        "phoneNumber": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "outbound": true,
        "inbound": true
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "nextCursor": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
cursor
string

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

​
limit
string

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

​
active
enum<string>

Filter by active status

Available options:
true,
false

Response

200
application/json

List of workflows

The response is of type object.