# Job stages

> A job's hiring pipeline, from the first stage to hired. Part of the HireHappy API reference (https://hirehappy.io/docs/api).

Base URL: `https://api.hirehappy.io/v1`. Authenticate with `Authorization: Bearer <API key>`.

### List a job's stages

`GET https://api.hirehappy.io/v1/jobs/{job_id}/job-stages`

Scope: `jobs:read`

The job's pipeline, in order.

**Path parameters**

| Name | Type | Description |
| --- | --- | --- |
| `job_id` | uuid | required |

**Example request**

```bash
curl "https://api.hirehappy.io/v1/jobs/7c2e4f1a-9b3d-4e6f-8a1c-2d3e4f5a6b7c/job-stages" \
  -H "Authorization: Bearer $HIREHAPPY_API_KEY"
```

**Response** `200` (an array)

| Name | Type | Description |
| --- | --- | --- |
| `id` | uuid |  |
| `job_id` | uuid |  |
| `name` | string |  |
| `position` | integer | 0 first. New applications start in the first stage; the last one is hired. |
| `kind` | enum | What the team does with an application there: nothing beyond moving it on (none), interview, call, assessment (work to hand in) or offer. one of `none`, `interview`, `call`, `assessment`, `offer` |
| `description` | string | A line or two on what happens in it, for the candidate. nullable |
| `is_public` | boolean | Shown to candidates on their status page as a step of their progress. |

```json
[
  {
    "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
  }
]
```

**Errors**: `401` the key is wrong, expired or revoked (api_key_required when missing); `403` the key isn't allowed jobs:read; `404` it isn't there, or belongs to another organization; `422` a parameter or field doesn't validate.
