Get job pipeline

GET

/api/nova/pipelines/job/{jobId}

Returns all pipeline entries (candidates) for the job given by the jobId path parameter. Each entry contains the pipeline entry id, jobId, candidateId, candidateName, the status code, the stage name, a rejected flag and the createdOn date. Accepts page and size query parameters (size defaults to 50 and is capped at 100), which are echoed back in the pagination metadata. Returns 401 if the API key is invalid.

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

50

Responses

OK

Content-Type

application/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

}

GET

/api/nova/pipelines/job/{jobId}

Playground

Authorization

privateApiKey

Variables

Key

Value

jobId*

apiKey*

page

size

Samples