Docs

Search the docs

Guides, sections and API endpoints

API reference

Job stages

A job's hiring pipeline, from the first stage to hired.

List a job's stages

get/jobs/{job_id}/job-stages

Needs the jobs:read scope

The job's pipeline, in order.

Path parameters

  • job_iduuidRequired

Returns 200

An array of objects like this one, all of them.

  • iduuid
  • job_iduuid
  • namestring
  • positioninteger
    0 first. New applications start in the first stage; the last one is hired.
  • kindenum
    What the team does with an application there: nothing beyond moving it on (none), interview, call, assessment (work to hand in) or offer.
    One ofnoneinterviewcallassessmentoffer
  • descriptionstringnullable
    A line or two on what happens in it, for the candidate.
  • is_publicboolean
    Shown to candidates on their status page as a step of their progress.

Errors

  • 401The key is wrong, expired or revoked (api_key_required when missing) invalid_api_key
  • 403The key isn't allowed jobs:read insufficient_scope
  • 404It isn't there, or belongs to another organization resource_not_found
  • 422A parameter or field doesn't validate missing, uuid_parsing, …
curl "https://api.hirehappy.io/v1/jobs/7c2e4f1a-9b3d-4e6f-8a1c-2d3e4f5a6b7c/job-stages" \
  -H "Authorization: Bearer $HIREHAPPY_API_KEY"
Response 200
[
  {
    "id": "a41f7b2c-3d5e-4f6a-9b8c-1d2e3f4a5b6c",
    "job_id": "7c2e4f1a-9b3d-4e6f-8a1c-2d3e4f5a6b7c",
    "name": "Interview",
    "position": 2,
    "kind": "interview",
    "description": "A 45-minute video call with the hiring manager.",
    "is_public": true
  }
]