Skip to main content
GET
/
api
/
v1
/
workflow
/
{id}
Get agent workflow
curl --request GET \
  --url https://prod.featherhq.com/api/v1/workflow/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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": [
      {
        "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
  },
  "maxDialsPerTick": 2,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

Response

Agent workflow retrieved successfully

​
id
string<uuid>
required

Workflow ID

​
name
string
required

Workflow name

​
description
string | null
required

Workflow description

​
organizationId
string<uuid>
required

Organization ID

​
userId
string<uuid>
required

User ID who created the workflow

​
active
boolean
required

Whether the workflow is active

​
startHour
integer
required

Start hour (0-23) for backward compatibility

​
endHour
integer
required

End hour (0-23) for backward compatibility

​
timezone
string
required

Timezone for workflow execution and schedule interpretation

​
workflowSchedule
object
required

Workflow schedule - operates in workflow timezone

Example:
{
  "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
object
required

TCPA schedule - applies to borrower local timezone

Example:
{
  "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
object
required

Workflow definition

​
maxDialsPerTick
integer | null
required

Per-workflow max dials per scheduler tick. null = uncapped (uses shared org budget).

Required range: x >= 1
​
createdAt
string
required

Creation timestamp

​
updatedAt
string
required

Last update timestamp