Skip to main content
GET
/
external
/
v1
/
hiring-flow
List Hiring Flows
curl --request GET \
  --url https://api.example.com/external/v1/hiring-flow/

​
List Hiring Flows

Retrieve a list of all hiring flows configured for your company.

​
Endpoint

GET /external/v1/hiring-flow/

​
Example Request

curl -X GET "https://your-instance.firstwork.com/external/v1/hiring-flow/" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "status": "success",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Software Engineer - Full Stack",
      "stages": [
        {
          "id": "stage-1-uuid",
          "name": "Application Received",
          "order": 1
        },
        {
          "id": "stage-2-uuid",
          "name": "Phone Screen",
          "order": 2
        },
        {
          "id": "stage-3-uuid",
          "name": "Technical Interview",
          "order": 3
        },
        {
          "id": "stage-4-uuid",
          "name": "Offer",
          "order": 4
        }
      ],
      "active_applications": 47,
      "created_at": "2024-12-01T08:00:00Z"
    },
    {
      "id": "660f9511-f30c-52e5-b827-557766551111",
      "name": "Customer Support Representative",
      "stages": [
        {
          "id": "stage-a-uuid",
          "name": "Application",
          "order": 1
        },
        {
          "id": "stage-b-uuid",
          "name": "Assessment",
          "order": 2
        },
        {
          "id": "stage-c-uuid",
          "name": "Onboarding",
          "order": 3
        }
      ],
      "active_applications": 203,
      "created_at": "2024-11-15T10:00:00Z"
    }
  ]
}