Stage Templates

These endpoints allow you to manage stage templates within the recruitment system. Stage templates define the individual steps or phases that make up a pipeline template.

Each stage template belongs to a specific pipeline template and represents a discrete step in the recruitment process, such as resume screening, phone interview, technical assessment, etc.

When positions are created, these templates can be used to automatically generate the appropriate stages for that position’s recruitment process.

Endpoints

get /api/v3/recruitment/stage_templates post /api/v3/recruitment/stage_templates delete /api/v3/recruitment/stage_templates/:resource_id get /api/v3/recruitment/stage_templates/:resource_id patch /api/v3/recruitment/stage_templates/:resource_id

get/api/v3/recruitment/stage_templates

Return a paginated list of recruitment/stage_templates

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
pipeline_template_id?: unknown
organizational_unit?: unknown
created_at?: unknown
updated_at?: unknown
pipeline_template_id?: unknown
The related resources to include in the response. Allowed resources are:
- `pipeline_template`
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;
    pipeline_template_id?: any;
    organizational_unit?: any;
    created_at?: any;
    updated_at?: any;
    pipeline_template_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `pipeline_template`
  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 or null
organizational_unit?: string
created_at?: datetime
updated_at?: datetime
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 | null;
      organizational_unit?: string;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/recruitment/stage_templates

Create a new recruitment/stage_templates

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
name?: string
description?: string
warning_after_days?: integer or null
index?: integer or null
organizational_unit?: string
created_at?: datetime
updated_at?: datetime
relationships?:
object
pipeline_template:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      description?: string;
      warning_after_days?: number | null;
      index?: number | null;
      organizational_unit?: string;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: {
      pipeline_template: { data: { type: string; id?: string } };
    };
  };
};

delete/api/v3/recruitment/stage_templates/:resource_id

Delete the recruitment/stage_templates

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/recruitment/stage_templates/:resource_id

Show a specific recruitment/stage_templates

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 or null
organizational_unit?: string
created_at?: datetime
updated_at?: datetime
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 | null;
      organizational_unit?: string;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/recruitment/stage_templates/:resource_id

Update a recruitment/stage_templates

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 or null
organizational_unit?: string
updated_at?: datetime

Typescript

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