Actions

91 actions

Action

Description

List Access Groups

Retrieve a list of access groups that define user permissions and roles within the platform.

Get Access Group

Fetch detailed information about a specific access group by ID.

Get Answer

Fetch a specific answer by ID.

Create Answer

Submit a candidate's answer to a screening question on an application or job seeker profile.

Update Answer

Modify a candidate's previously submitted answer to update the response value.

Delete Answer

Remove a candidate's answer from the system.

List Applications

Retrieve a paginated list of job applications with optional filtering by candidate email, job, stage, and other criteria...

Get Application

Fetch detailed information about a specific application by ID, including candidate details, current stage, job informati...

Create Application

Create a new job application for a candidate, submitting their profile to a specific job posting with required informati...

Update Application

Update an existing application's details, move it to a different stage in the hiring workflow, or modify application met...

Delete Application

Remove an application from the system.

List Candidate Surveys

Retrieve candidate survey responses to analyze post-interview feedback, experience ratings, and candidate satisfaction d...

Get Candidate Survey

Fetch individual candidate survey response to review detailed feedback and experience ratings from a specific candidate.

List Candidates

Retrieve a paginated list of candidate profiles with optional filtering and related resources.

Get Candidate

Fetch detailed information about a specific candidate by ID.

Update Candidate

Update candidate profile information including contact details, skills, and custom attributes.

List Comments

Retrieve comments and notes on applications or candidates for team collaboration and feedback synchronization across hir...

Get Comment

Fetch a specific comment by ID to retrieve detailed feedback, interviewer notes, or team discussion threads.

Create Comment

Add a comment or note to an application or candidate profile to record interviewer feedback, hiring team discussions, or...

List Custom Fields

Retrieve custom field definitions to discover organization-specific data fields configured for applications, jobs, candi...

Get Custom Field

Fetch detailed information about a specific custom field including its schema, validation rules, and applicable resource...

Create Custom Field

Define a new custom field to track organization-specific information on applications, jobs, candidates, or offers with c...

Update Custom Field

Modify custom field configuration including validation rules, display options, and field metadata to adapt to changing b...

Delete Custom Field

Remove a custom field definition from the system, which will also delete all associated custom attribute values.

List Custom Attributes

Retrieve custom attribute values set on resource instances to access organization-specific data stored on applications,...

Create Custom Attribute

Set a custom attribute value on a resource instance to store organization-specific data on applications, jobs, or candid...

Get Custom Attribute

Fetch a specific custom attribute by ID to retrieve its current value and related metadata.

Update Custom Attribute

Update the value of an existing custom attribute. Only value fields may be changed; reassociation is not supported.

Delete Custom Attribute

Remove a custom attribute value from a resource instance to clear organization-specific data that is no longer needed.

List Hiring Workflows

Retrieve hiring workflow templates to display available workflows when creating jobs and understand standard hiring proc...

Get Hiring Workflow

Fetch detailed information about a specific hiring workflow including all stages, requirements, and configuration settin...

List Interviews

Retrieve a list of scheduled interviews with participant information for calendar synchronization and scheduling coordin...

Get Interview

Fetch detailed information about a specific interview including date, time, participants, location, and associated appli...

Update Interview

Update an interview's summary in HTML format. Only the summary field is supported for updates.

List Job Seekers

Retrieve a list of job seeker profiles from the passive candidate pool for proactive talent sourcing and pipeline buildi...

Get Job Seeker

Fetch detailed information about a specific job seeker including profile, preferences, and passive candidate pool status...

List Jobs

Retrieve a paginated list of job postings with optional filters for status, department, location, and other criteria to...

Get Job

Fetch detailed information about a specific job posting including description, requirements, hiring workflow, department...

Create Job

Create a new job posting with title, description, status, hiring workflow, and organizational structure links for depart...

Update Job

Update an existing job posting.

Delete Job

Delete a job posting.

List Onboarding Applications

Retrieve a list of onboarding applications to track new hire onboarding progress, task completion, and document collecti...

Get Onboarding Application

Fetch detailed information about a specific onboarding application including tasks, documents, and completion status for...

List Positions

Retrieve a list of positions

Fetch Position

Retrieve a single position by ID

List Structured Sections

Retrieve structured section definitions for onboarding workflows to understand form layouts and data collection requirem...

Get Structured Section

Fetch detailed information about a specific structured section to understand its form layout, field definitions, and dat...

Create Structured Section Response

Submit a response to a structured onboarding section to record candidate or new hire data in onboarding forms and workfl...

Update Structured Section Response

Modify a structured onboarding section response to update new hire information or correct onboarding form submissions.

Delete Structured Section Response

Remove a structured onboarding section response to clear incorrect form submissions or reset onboarding data.

List Departments

Retrieve a list of company departments for organizing job postings and managing organizational hierarchy in the ATS.

Get Department

Fetch detailed information about a specific department including name, hierarchy, and associated job postings.

Create Department

Create a new department to organize job postings and manage organizational hierarchy in the ATS.

Update Department

Update department details such as name or organizational hierarchy to sync changes from external HR systems.

Delete Department

Remove a department from the system to archive outdated department records from the organizational structure.

List Divisions

Retrieve a list of company divisions for high-level organizational structure reporting and hierarchy management.

Get Division

Fetch detailed information about a specific division including its departments and organizational position within the co...

Create Division

Create a new division for high-level organizational structure reporting and hierarchy management.

Update Division

Update division details such as name or organizational position to sync changes from external HR systems.

Delete Division

Remove a division from the system to archive outdated division records from the organizational structure.

List Equality Monitoring Categories

Retrieve all equality monitoring categories configured in the system for tracking diversity and inclusion data.

Get Equality Monitoring Category

Retrieve detailed information about a specific equality monitoring category including its enabled status and associated...

List Locations

Retrieve a list of company office locations for filtering job postings and displaying available work locations to candid...

Get Location

Fetch detailed information about a specific office location including address, city, state, country, and timezone inform...

Create Location

Create a new office location for filtering job postings and displaying available work locations to candidates.

Update Location

Update location details such as address, contact information, or office status to sync changes from external HR systems.

Delete Location

Remove a location from the system to archive closed offices or outdated location records from the organizational structu...

List Structure Links

Retrieve structure links that associate departments with locations to map job postings to specific organizational combin...

Get Structure Link

Fetch a specific structure link to understand the department-location association for a particular organizational unit.

Create Structure Link

Create a new department-location association to set up organizational structure for new offices or department expansions...

Update Structure Link

Update a structure link. Only the accepts\_speculative\_applications attribute can be modified.

Delete Structure Link

Permanently delete a structure link from the system to remove department-location associations.

List Structure Custom Group Ones

Retrieve a list of custom organizational groups for structuring teams and departments.

Create Structure Custom Group One

Create a new custom organizational group for structuring teams and departments.

Get Structure Custom Group One

Retrieve a specific custom organizational group by ID.

Update Structure Custom Group One

Update an existing custom organizational group.

Delete Structure Custom Group One

Delete a custom organizational group.

List Questions

Retrieve all screening questions used across jobs and applications to manage candidate qualification criteria and assess...

List Requisition Templates

Retrieve a list of requisition templates used for creating job requisitions.

Get Requisition Template

Retrieve a specific requisition template by ID with related fields.

List Requisitions

Retrieve a list of hiring requisitions with approval workflows and headcount tracking.

Get Requisition

Retrieve a specific requisition by ID with related resources and custom details.

Update Requisition

Archive a requisition by setting archived status to true.

Delete Requisition

Permanently delete a requisition by ID.

Create Requisition

Create a new hiring requisition with approval workflows and headcount tracking.

List Scorecards

Retrieve a list of interview scorecards to access evaluation criteria, rating scales, and interviewer feedback templates...

Get Scorecard

Fetch detailed information about a specific scorecard including evaluation criteria, rating scales, and feedback questio...

List Users

Retrieve a list of platform users to sync hiring team members, permissions, and user access across integrated systems.

Get User

Fetch detailed information about a specific user including profile, role, permissions, and department assignments.

Create User

Create a new user in the system. As a bare minimum, first\_name, last\_name, and email must be supplied. user\_type must al...

Delete User

Permanently delete a user from the system to remove access and archive user records.