GET
/
workflows
/
{id}
curl --request GET \
  --url https://prod.featherhq.com/workflows/{id} \
  --header 'x-api-key: <api-key>'
{
  "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
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Response

200
application/json

Workflow retrieved successfully

The response is of type object.