company\_holidays company\_legal\_entities company\_locations contracts custom\_fields employee\_updates employees recruitment time\_off

127 actions

Action

Description

Required scopes

Get Credentials

Retrieve information about the current API token owner.

List Answers

Retrieve a list of all answers to job application questions

Create Answer

Create a new answer to an application question

Get Answer

Retrieve detailed information for a specific answer

List Application Phases

Retrieve a list of all application phases in the hiring pipeline.

Get Application Phase

Retrieve detailed information for a specific application phase

List Applications

Retrieve a list of all job applications

Create Application

Create a new job application

Get Application

Retrieve detailed information for a specific application

Update Application

Update an existing job application

Delete Application

Delete a specific job application

Apply To Job

Submit a job application as a candidate

List Candidate Sources

Retrieve a list of all candidate sources.

Get Candidate Source

Retrieve detailed information for a specific candidate source

List Candidates

Retrieve a list of all candidates.

Create Candidate

Create a new candidate in the ATS

Get Candidate

Retrieve detailed information for a specific candidate

Update Candidate

Update an existing candidate

Delete Candidate

Delete a specific candidate

List Hiring Stages

Retrieve a list of all hiring stages

Get Hiring Stage

Retrieve detailed information for a specific hiring stage

List Job Postings

Retrieve a list of all job postings

Create Job Posting

Create a new job posting

Get Job Posting

Retrieve detailed information for a specific job posting

Update Job Posting

Update an existing job posting

Delete Job Posting

Delete a specific job posting

Duplicate Job Posting

Duplicate an existing job posting

List Questions

Retrieve a list of all questions.

Create Question

Create a new question for a job posting

Get Question

Retrieve detailed information for a specific question

Update Question

Update an existing question

Delete Question

Delete a specific question

List Rejection Reasons

Retrieve a list of all rejection reasons.

Get Rejection Reason

Retrieve detailed information for a specific rejection reason

List Legal Entities

Retrieve a list of all legal entities

Create Legal Entity

Create a new legal entity

Get Legal Entity

Retrieve a single legal entity by ID

List Compensation Concepts

Retrieve a list of all compensation concepts

Get Compensation Concept

Retrieve a single compensation concept by ID

List Custom Fields

Retrieve a list of all custom fields with filtering options

Get Custom Field

Retrieve detailed information for a specific custom field

Create Custom Field

Create a new custom field definition

Delete Custom Field

Delete a custom field definition

List Custom Field Options

Retrieve all options for custom fields

Create Custom Field Option

Create a new option for a custom field

Get Custom Field Option

Retrieve a specific custom field option by ID

List Resource Fields

Retrieve all resource fields for custom schemas

Create Resource Field

Create a new resource field for a schema

Get Resource Field

Retrieve a specific resource field by ID

List Custom Field Values

Retrieve all custom field values

Create Custom Field Value

Create a new custom field value

Get Custom Field Value

Retrieve a specific custom field value by ID

Update Custom Field Value

Update an existing custom field value

List Custom Resources

Retrieve all custom resources

Get Custom Resource

Retrieve a specific custom resource by ID

List Custom Resource Schemas

Retrieve all custom resource schemas

Create Custom Resource Schema

Create a new custom resource schema

Get Custom Resource Schema

Retrieve a specific custom resource schema by ID

List Custom Resource Values

Retrieve all custom resource values

Create Custom Resource Value

Create a new custom resource value

Get Custom Resource Value

Retrieve a specific custom resource value by ID

List Employee Update Absences

Retrieve all absence employee updates

Get Employee Update Absence

Retrieve a specific absence employee update by ID

List Employee Update Contract Changes

Retrieve all contract change employee updates

Get Employee Update Contract Change

Retrieve a specific contract change employee update by ID

List Employee Update New Hires

Retrieve all new hire employee updates

Get Employee Update New Hire

Retrieve a specific new hire employee update by ID

List Employee Update Personal Changes

Retrieve all personal change employee updates

Get Employee Update Personal Change

Retrieve a specific personal change employee update by ID

List Employee Update Summaries

Retrieve all employee update summaries

Get Employee Update Summary

Retrieve a specific employee update summary by ID

List Employee Update Terminations

Retrieve all termination employee updates

Get Employee Update Termination

Retrieve a specific termination employee update by ID

List Employees

Retrieve a list of all employees

Get Employee

Retrieve detailed information for a specific employee

Update Employee

Update an existing employee's information

Create Employee With Contract

Create a new employee with contract details

Invite Employee

Send an email invitation to an unconfirmed employee

Set Employee Access Start Date

Set regular access start date for an employee

Terminate Employee

Terminate an employee

Unterminate Employee

Reverse the termination of an employee

List Company Holidays

Retrieve all company holidays

Get Company Holiday

Retrieve a specific company holiday by ID

List Locations

Retrieve a list of all locations

Get Location

Retrieve detailed information for a specific location

Create Location

Create a new location

Update Location

Update an existing location

Delete Location

Delete a location

List Work Areas

Retrieve a list of all work areas

Get Work Area

Retrieve detailed information for a specific work area

Create Work Area

Create a new work area

Update Work Area

Update an existing work area

Archive Work Area

Archive a work area

Unarchive Work Area

Unarchive a work area

List Team Memberships

Retrieve a list of all team memberships

Get Team Membership

Retrieve detailed information for a specific team membership

Create Team Membership

Create a new team membership

Update Team Membership

Update an existing team membership

Delete Team Membership

Delete a team membership

List Teams

Retrieve a list of all teams

Get Team

Retrieve detailed information for a specific team

Create Team

Create a new team

Update Team

Update an existing team

Delete Team

Delete a team

List Leave Types

Retrieve all leave types

Create Leave Type

Create a new leave type

Get Leave Type

Retrieve a specific leave type by ID

Update Leave Type

Update an existing leave type

List Leaves

Retrieve all leave requests

Create Leave

Create a new leave request

Get Leave

Retrieve a specific leave request by ID

Update Leave

Update an existing leave request

Delete Leave

Delete a leave request

Approve Leave

Approve a leave request

Approve All Leaves

Approve multiple leave requests

Reject Leave

Reject a leave request

List Timeoff Policies

Retrieve all timeoff policies

Create Timeoff Policy

Create a new timeoff policy

Get Timeoff Policy

Retrieve a specific timeoff policy by ID

Update Timeoff Policy

Update an existing timeoff policy

Delete Timeoff Policy

Delete a timeoff policy

List Policy Assignments

Retrieve all policy assignments

Create Policy Assignment

Create a new policy assignment

Get Policy Assignment

Retrieve a specific policy assignment by ID

Update Policy Assignment

Update an existing policy assignment

Delete Policy Assignment

Delete a policy assignment

List Policy Timelines

Retrieve all policy timelines

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.