Skip to main content
POST
GetPipelineStage

Authorizations

Authorization
string
header
required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json

Request for getting a single pipeline stage

pipelineStageId
string<uuid>

ID of the pipeline stage to retrieve

Response

Success

Response for a single pipeline stage

pipelineStageId
string

ID of the pipeline stage

name
string

Name of the stage

position
string<int64>

Position of the stage within the pipeline

colorRed
integer<int32>

RGB color components

colorGreen
integer<int32>

green color component

colorBlue
integer<int32>

blue color component

isUnreviewed
boolean

Flags indicating the stage type

isAccepted
boolean

accepted type

isRejected
boolean

rejected type

autoInformCrewByEmail
boolean | null

toggle auto information a crew by email about rejected application

candidateStatus
enum<string>

what happens to candidates in this stage

Available options:
PIPELINE_STAGE_CANDIDATE_STATUS_UNSPECIFIED,
PIPELINE_STAGE_CANDIDATE_STATUS_IN_PROGRESS,
PIPELINE_STAGE_CANDIDATE_STATUS_COMPLETED,
PIPELINE_STAGE_CANDIDATE_STATUS_REJECTED