Read a job pipeline
Read the stages of one job and the candidates in each.
GET https://cotlet.dev/api/v1/loxo/jobs/{job_id}/pipeline
read
Returns the job title, the total number of candidates in the pipeline and, per stage, its count and its candidates with person_id and name. Stages come in the order of your workflow. total_candidates covers the whole pipeline even when stage limits the stages returned.
Parameters
| Name | Type | Description |
|---|---|---|
| job_id integer required | integer | Job id from list_jobs. |
| stage string | string | Stage name from list_workflow_stages. Without it, every stage is returned. |
Request
curl https://cotlet.dev/api/v1/loxo/jobs/1/pipeline \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("loxo", "get_job_pipeline", {"job_id":1})const result = await cotlet.call('loxo', 'get_job_pipeline', {"job_id":1});cotlet call loxo get_job_pipeline --data '{"job_id":1}'Example response
{
"job_id": 2481530,
"title": "Senior Data Engineer",
"total_candidates": 14,
"stages": [
{
"stage": "Shortlist",
"count": 3,
"candidates": [
{
"person_id": 48211077,
"name": "Priya Nair"
},
{
"person_id": 48211102,
"name": "Tom Becker"
},
{
"person_id": 48211130,
"name": "Lena Ortiz"
}
]
}
]
}