admin:read admin:read\_write admin:write internal:read internal:read\_write internal:write public:read public:read\_write public:write

106 actions

Action

Description

Required scopes

Get Activity

Retrieve a specific activity record by its unique identifier. Activities represent actions performed within the recruitm...

List Candidate Activities

Retrieve all activities associated with a specific candidate. This returns a chronological feed of actions and events re...

List Job Activities

Retrieve all activities associated with a specific job posting. This returns a chronological feed of actions and events...

List User Activities

Retrieve all activities performed by a specific user in the recruitment system. This returns a chronological feed of act...

List Answers

Retrieve candidate responses to application questions. IMPORTANT - You must use filter\_question parameter to avoid timeo...

Get Answer

Retrieve a specific answer by its unique identifier. Returns the complete response including the answer content and meta...

Create Answer

Create a new answer for a candidate's response to an application question. Requires candidate\_id from list\_candidates, q...

Get Answer Authenticated Video URL

Retrieve a time-limited authenticated URL for accessing video answer content. The returned URL is valid for 2 hours and...

List Candidates

Retrieve a paginated list of all candidates in the recruitment system. Candidates are individuals who have applied for p...

Get Candidate

Retrieve complete information about a specific candidate using their unique identifier. Returns the full candidate profi...

Create Candidate

Add a new candidate to the recruitment system with their profile information. Conditional requirement - either email is...

Update Candidate

Modify an existing candidate's profile information. Use this to update contact details, correct information, or add addi...

Delete Candidate

Permanently remove a candidate and all their associated data from the system. This action cannot be undone and should be...

Get Company

Retrieve the organization's company profile and account settings. Returns core company information including company nam...

Update Company

Update the organization's company profile settings. Allows modifying company name and website. Can also update the manag...

List Custom Field Values

Retrieve custom field values for specific candidates or jobs.

Get Custom Field Value

Retrieve a specific custom field value by its unique identifier. Obtain the ID from list\_custom\_field\_values action.

Create Custom Field Value

Set a custom field value for a candidate. Requires custom\_field\_id from list\_custom\_fields (must be a Candidate owner-ty...

Update Custom Field Value

Modify an existing custom field value. Requires id from list\_custom\_field\_values or create\_custom\_field\_value.

List Custom Fields

Retrieve all custom field definitions configured in the system. Custom fields extend the standard candidate and job data...

Get Custom Field

Retrieve a specific custom field definition by its unique identifier. Requires id obtained from list\_custom\_fields.

Create Custom Field

Create a new custom field definition for candidates or jobs.

Update Custom Field

Update an existing custom field definition. Requires id from list\_custom\_fields. Note that api-name cannot be changed af...

Get Custom Field Select

Retrieve a specific select-type custom field by its unique identifier. Returns the complete field configuration includin...

Create Custom Field Select

Create a new select-type custom field definition. Allows creating single-select or multi-select fields with predefined o...

Update Custom Field Select

Update an existing select-type custom field definition. Allows modifying the name or API name of an existing select or m...

List Custom Field Options

Retrieve all available options for select-type custom fields. Options are the individual choices that appear in dropdown...

Get Custom Field Option

Retrieve a specific custom field option by its unique identifier. Returns the option's value and the custom field it bel...

Create Custom Field Option

Create a new option for a select-type custom field. Adds a new choice to the dropdown menu of an existing single-select...

Update Custom Field Option

Update an existing custom field option. Allows modifying the display value of a dropdown choice.

List Divisions

Retrieve all divisions configured in the organization. Divisions represent the highest level of organizational hierarchy...

Get Division

Retrieve detailed information about a specific division by its unique identifier. Returns the division name and related...

List Departments

Retrieve a paginated list of all departments in the organization. Departments are used to categorize jobs and organize t...

Get Department

Retrieve complete information about a specific department using its unique identifier. Returns the department name, asso...

Create Department

Add a new department to the organizational structure. Departments are used to categorize jobs and appear as filters on t...

Update Department

Modify an existing department's information, such as renaming it. Useful for organizational restructuring or keeping dep...

Delete Department

Permanently remove a department from the organizational structure. Before deleting, ensure no jobs are assigned to this...

List Forms

Retrieve all forms configured in the organization. Forms are customizable questionnaires used to collect structured info...

Get Form

Retrieve detailed information about a specific form by its unique identifier. Returns the form configuration, title, and...

List Form Questions

Retrieve all questions used across forms. Questions define what information is collected from candidates, including the...

Get Form Question

Retrieve a specific form question by its unique identifier. Returns the complete question configuration including text,...

List Form Answers

Retrieve candidate responses to form questions. Answers contain the actual data submitted by candidates when completing...

Get Form Answer

Retrieve a specific form answer by its unique identifier. Returns the complete response including the question asked and...

List Interviews

Retrieve all scheduled interviews across the organization. Interviews are meetings arranged between candidates and team...

Get Interview

Retrieve detailed information about a specific interview by its unique identifier. Returns the complete interview record...

List Jobs

Retrieve a paginated list of all job postings in the system. Jobs represent open positions that candidates can apply for...

Get Job

Retrieve complete information about a specific job posting using its unique identifier. Returns the full job details inc...

Create Job

Create a new job posting in the recruitment system. The job can be created as a draft for review or published immediatel...

Update Job

Modify an existing job posting. Use this to update job details, change the status, or edit the description. Commonly use...

Delete Job

Permanently remove a job posting and all its associated data from the system. This action cannot be undone. Consider arc...

List Job Applications

Retrieve a paginated list of all job applications in the system. Job applications represent candidates who have applied...

Get Job Application

Retrieve complete information about a specific job application using its unique identifier. Returns the full application...

Create Job Application

Submit a new job application connecting a candidate to a specific job position. This creates the link between a candidat...

Update Job Application

Modify a job application to update the cover letter. Requires Admin scope with write permissions.

List Job Offers

Retrieve all employment offers that have been extended to candidates. Job offers track the formal offer process includin...

Get Job Offer

Retrieve detailed information about a specific job offer by its unique identifier. Returns the complete offer record inc...

List Locations

Retrieve a paginated list of all office locations in the organization. Locations represent physical offices or work site...

Get Location

Retrieve complete information about a specific location using its unique identifier. Returns the full address details, g...

Create Location

Add a new office location to the organization. Locations are used to categorize jobs geographically and appear as filter...

Update Location

Modify an existing location's information such as its name or address details. Useful when office addresses change or na...

Delete Location

Permanently remove a location from the organization. Before deleting, ensure no jobs are assigned to this location or re...

List Notes

Retrieve a paginated list of all notes and comments recorded on candidates and their job applications. Notes capture rec...

Get Note

Retrieve the complete content of a specific note using its unique identifier. Returns the full note text, information ab...

Create Note

Add a new note or comment to a candidate's profile. Use this to record interview feedback, document observations, or sha...

Create Note On Application

Add a new note or comment to a specific job application. Use this when the feedback is specific to one application rathe...

Update Note

Modify the content of an existing note. Use this to correct information, add additional details, or update feedback afte...

Delete Note

Permanently remove a note from a candidate or job application. Use this to delete outdated information, remove inappropr...

List Onboardings

Retrieve all onboarding records for hired candidates. Onboardings track the new hire process from offer acceptance throu...

Get Onboarding

Retrieve detailed information about a specific onboarding record by its unique identifier. Returns the complete onboardi...

List Picked Questions

Retrieve the mapping of questions to specific jobs. Picked questions represent which questions from the library have bee...

List Questions

Retrieve all questions from the organization's question library. Questions are reusable across multiple job postings and...

List Reject Reasons

Retrieve all configured rejection reasons available in the system. Rejection reasons provide standardized explanations f...

Get Reject Reason

Retrieve a specific rejection reason by ID.

Create Reject Reason

Add a new rejection reason option.

Update Reject Reason

Modify an existing rejection reason. Requires reject reason id from list\_reject\_reasons.

Delete Reject Reason

Remove a rejection reason option. Requires reject reason id from list\_reject\_reasons.

List Requisitions

Retrieve all job requisitions and their approval status. Requisitions are formal requests to fill a position, often requ...

Get Requisition

Retrieve detailed information about a specific requisition by its unique identifier. Returns the complete requisition in...

Create Requisition

Submit a new job requisition for approval. This initiates the hiring approval workflow, requesting permission to fill a...

Update Requisition

Modify an existing requisition's details such as the job title or draft status. Requires requisition id from list\_requis...

List Roles

Retrieve all job role categories configured in the organization. Roles classify jobs by function or area of expertise su...

Get Role

Retrieve a specific role by its unique identifier. Returns the role name and configuration.

Create Role

Create a new job role category in the organization. Roles classify jobs by function or area of expertise such as Enginee...

Delete Role

Delete a job role category from the organization. Requires role id from list\_roles.

List Stages

Retrieve all hiring pipeline stages across jobs. Stages represent the steps candidates progress through during recruitme...

Get Stage

Retrieve complete information about a specific hiring stage using its unique identifier. Returns the stage name, type, p...

Create Stage

Add a new stage to a job's hiring pipeline. Use this to customize the recruitment workflow with additional steps like te...

List Stage Types

Retrieve all available stage type definitions that categorize stages in the hiring pipeline. Stage types include Inbox f...

Get Stage Type

Retrieve a specific stage type by its unique identifier. Returns the stage type name and configuration.

List Teams

Retrieve all teams configured in the organization. Teams group users together for permission management and collaborativ...

Get Team

Retrieve detailed information about a specific team by ID.

Create Team

Add a new team for organizing users and managing access. Requires user\_id from list\_users as the team manager.

Update Team

Update an existing team's information. Requires team id from list\_teams.

Delete Team

Remove a team from the organization. Requires team id from list\_teams.

List Team Memberships

Retrieve team membership records showing user-team associations.

Get Team Membership

Retrieve details of a specific team membership by ID.

Create Team Membership

Add a user to a team. Requires user\_id from list\_users and team\_id from list\_teams.

Delete Team Membership

Remove a user from a team. Requires membership id from list\_team\_memberships.

List Users

Retrieve a paginated list of all users in the system. Users include recruiters, hiring managers, administrators, and oth...

Get User

Retrieve complete information about a specific user using their unique identifier. Returns the user's profile details, r...

Create User

Add a new team member to the Teamtailor system. Use this to onboard new recruiters, create hiring manager accounts, or s...

Update User

Modify an existing user's profile information, role, or visibility settings. Use this to update names, change permission...

Delete User

Remove a user account from the system. Before deleting, reassign any jobs owned by this user to another team member. Thi...

List Uploads

Retrieve all file uploads attached to candidates. Uploads include resumes, cover letters, portfolios, and other document...

Get Upload

Retrieve a specific upload by ID.

Create Upload

Attach a file to a candidate profile using a public URL. Requires candidate\_id from list\_candidates.