GET
/
api
/
v1
/
workflow
List agent workflows
curl --request GET \
  --url https://prod.featherhq.com/api/v1/workflow \
  --header 'X-API-Key: <api-key>'
{
  "workflows": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true,
      "startHour": 123,
      "endHour": 123,
      "timezone": "<string>",
      "workflowSchedule": {
        "monday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 9,
              "startMinute": 0,
              "endHour": 17,
              "endMinute": 0
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 9,
              "startMinute": 0,
              "endHour": 17,
              "endMinute": 0
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 9,
              "startMinute": 0,
              "endHour": 17,
              "endMinute": 0
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 9,
              "startMinute": 0,
              "endHour": 17,
              "endMinute": 0
            }
          ]
        },
        "friday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 9,
              "startMinute": 0,
              "endHour": 17,
              "endMinute": 0
            }
          ]
        },
        "saturday": {
          "enabled": false,
          "timeRanges": []
        },
        "sunday": {
          "enabled": false,
          "timeRanges": []
        }
      },
      "tcpaSchedule": {
        "monday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 8,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 8,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 8,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 8,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        },
        "friday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 8,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 8,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "timeRanges": [
            {
              "startHour": 13,
              "startMinute": 0,
              "endHour": 21,
              "endMinute": 0
            }
          ]
        }
      },
      "definition": {
        "steps": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "CALL",
            "order": 2,
            "delayInSecs": 0,
            "needsTCPACompliance": true,
            "finishOn": [],
            "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "leaveVoicemail": false,
            "conditions": []
          }
        ]
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pagination": {
    "limit": 10,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

active
string

Filter by active status

cursor
string
limit
string
default:10

Response

200
application/json

Agent workflows retrieved successfully

The response is of type object.