Skip to main content
GET
/
external
/
v1
/
hiring-flow
/
{hiring_flow_id}
Get Hiring Flow
curl --request GET \
  --url https://api.example.com/external/v1/hiring-flow/{hiring_flow_id}/

Get Hiring Flow Details

Retrieve detailed information about a specific hiring flow, including stages, forms, and configuration.

Endpoint

GET /external/v1/hiring-flow/{hiring_flow_id}/

Path Parameters

ParameterTypeRequiredDescription
hiring_flow_idstring (UUID)YesThe hiring flow ID

Example Request

curl -X GET "https://your-instance.firstwork.com/external/v1/hiring-flow/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "status": "success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Software Engineer - Full Stack",
    "description": "Hiring pipeline for full-stack software engineers",
    "stages": [
      {
        "id": "stage-1-uuid",
        "name": "Application Received",
        "order": 1,
        "forms": [
          {
            "id": "form-1-uuid",
            "name": "Personal Information"
          }
        ]
      },
      {
        "id": "stage-2-uuid",
        "name": "Phone Screen",
        "order": 2,
        "forms": []
      },
      {
        "id": "stage-3-uuid",
        "name": "Technical Interview",
        "order": 3,
        "forms": [
          {
            "id": "form-2-uuid",
            "name": "Technical Assessment"
          }
        ]
      },
      {
        "id": "stage-4-uuid",
        "name": "Offer",
        "order": 4,
        "forms": [
          {
            "id": "form-3-uuid",
            "name": "Offer Acceptance"
          }
        ]
      }
    ],
    "active_applications": 47,
    "total_applications": 312,
    "created_at": "2024-12-01T08:00:00Z",
    "updated_at": "2025-01-15T12:00:00Z"
  }
}

Error Responses

CodeDescription
401Invalid API key
404Hiring flow not found