Skip to main content
GET
Get a job stage
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

jobStageId
string
required

a job stage ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:stg_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Response

Success

id
string
required

Canonical job stage ID (stg_ followed by 32 lowercase hexadecimal UUID characters).

Pattern: ^stg_[0-9a-f]{32}$
Example:

"stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"

job_id
string
required

Canonical job ID (job_ followed by 32 lowercase hexadecimal UUID characters).

Pattern: ^job_[0-9a-f]{32}$
Example:

"job_a1b2c3d4e5f64789a1b2c3d4e5f64789"

name
string
required
index
integer
required
schedulable
boolean
required
ats
object | null
required
has_custom_interview_plan
boolean
required
settings
object
required
created_at
string<date-time>
required

ISO 8601 timestamp.

updated_at
string<date-time>
required

ISO 8601 timestamp.