Skip to content

List pipeline candidates​

GET
/api/nova/jobs/{jobId}/pipeline

Lists the candidates in the pipeline of the job identified by the jobId path variable, returning one entry per candidate with their current pipeline stage. Query parameters are apiKey (required) plus page and size for pagination; size is capped at 100 and pagination is applied in memory over the job's full pipeline. The response contains the pipeline entries with page, size and total count. Returns 401 for an invalid API key and 500 with an error message on failure.

Authorizations​

privateApiKey
Type
API Key (query: apiKey)

Parameters​

Path Parameters

jobId*

jobId

Type
string
Required

Query Parameters

apiKey*

apiKey

Type
string
Required
page

page

Type
integer
Format
"int32"
Default
0
size

size

Type
integer
Format
"int32"
Default
20

Responses​

OK

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"candidateId": "string",
  
  
  
"candidateName": "string",
  
  
  
"createdOn": "string",
  
  
  
"id": "string",
  
  
  
"jobId": "string",
  
  
  
"rejected": true,
  
  
  
"stage": "string",
  
  
  
"status": "string"
  
  
}
  
],
  
"error": "string",
  
"message": "string",
  
"page": 0,
  
"requestId": "string",
  
"size": 0,
  
"success": true,
  
"total": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Recruitly — Recruitment CRM for Agencies