Stages

These endpoints allow you to manage recruitment stages for specific positions. Stages represent the actual steps in a recruitment process that candidates move through.

Each stage is associated with a position and is typically created based on stage templates from a pipeline template. Stages can be created individually or generated collectively from a pipeline template using the dedicated endpoint.

The recruitment process for each position consists of multiple stages that candidates progress through until they are hired or rejected.

Endpoints

get /api/v3/recruitment/stages delete /api/v3/recruitment/stages/:resource_id get /api/v3/recruitment/stages/:resource_id patch /api/v3/recruitment/stages/:resource_id post /api/v3/recruitment/stages/create_with_templates

get/api/v3/recruitment/stages

Return a paginated list of recruitment/stages

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
name?: unknown
description?: unknown
warning_after_days?: unknown
index?: unknown
position_id?: unknown
created_by_id?: unknown
updated_by_id?: unknown
name__match?: unknown
position_id?: unknown
The related resources to include in the response. Allowed resources are:
- `position`
included?:
array
Elements: string
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    name?: any;
    description?: any;
    warning_after_days?: any;
    index?: any;
    position_id?: any;
    created_by_id?: any;
    updated_by_id?: any;
    name__match?: any;
    position_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `position`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
name?: string
description?: string
warning_after_days?: integer or null
index?: integer
created_by_id?: integer
updated_by_id?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      description?: string;
      warning_after_days?: number | null;
      index?: number;
      created_by_id?: number;
      updated_by_id?: number;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

delete/api/v3/recruitment/stages/:resource_id

Delete the recruitment/stages

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/recruitment/stages/:resource_id

Show a specific recruitment/stages

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
name?: string
description?: string
warning_after_days?: integer or null
index?: integer
created_by_id?: integer
updated_by_id?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      description?: string;
      warning_after_days?: number | null;
      index?: number;
      created_by_id?: number;
      updated_by_id?: number;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/recruitment/stages/:resource_id

Update a recruitment/stages

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
description?: string
warning_after_days?: integer or null
index?: integer
updated_by_id?: integer

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      description?: string;
      warning_after_days?: number | null;
      index?: number;
      updated_by_id?: number;
    };
  };
};

post/api/v3/recruitment/stages/create_with_templates

Create stages from the pipeline_template id for a position

Input Schema

object
pipeline_template_id: integer
position_id: integer

Typescript

type InputSchema = { pipeline_template_id: number; position_id: number };