Teamtailor Connector for AI agents

Complete Coverage

Discover what’s possible

with

Teamtailor

.

Book a Demo Read Docs

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

Create Answer

Create A New Answer For A Candidate'S Response To An Application Question. Requires Candidate_id From List_candidates, Question_id From List_questions, And Picked_question_id From List_picked_questions.

Create Candidate

Add A New Candidate To The Recruitment System With Their Profile Information. Conditional Requirement - Either Email Is Required OR Sourced Must Be Set To True. This Creates A Candidate Record That Can Then Be Associated With Job Applications. Requires Admin Scope With Write Permissions.

Create Custom Field

Create A New Custom Field Definition For Candidates Or Jobs.

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 Or Multi-Select Field.

Create Custom Field Select

Create A New Select-Type Custom Field Definition. Allows Creating Single-Select Or Multi-Select Fields With Predefined Options That Users Can Choose From.

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-Type Field) And Candidate_id From List_candidates.

Create Department

Add A New Department To The Organizational Structure. Departments Are Used To Categorize Jobs And Appear As Filters On The Career Site. Requires Write Permissions.

Create Job

Create A New Job Posting In The Recruitment System. The Job Can Be Created As A Draft For Review Or Published Immediately To Your Career Site. You Must Specify A User Who Will Own And Manage The Job. Requires Write Permissions.

Create Job Application

Submit A New Job Application Connecting A Candidate To A Specific Job Position. This Creates The Link Between A Candidate And A Job And Places Them Into The Hiring Pipeline. Requires Admin Scope With Write Permissions.

Create Location

Add A New Office Location To The Organization. Locations Are Used To Categorize Jobs Geographically And Appear As Filters On The Career Site. Requires Write Permissions.

Create Note

Add A New Note Or Comment To A Candidate'S Profile. Use This To Record Interview Feedback, Document Observations, Or Share Information With The Hiring Team About A Candidate. Requires Admin Scope With Write Permissions.

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 Rather Than The Candidate Overall, Such As Interview Notes For A Particular Position. Requires Admin Scope With Write Permissions.

Create Region

Create A New Geographic Region In The Organization. Regions Group Multiple Locations Together For Broader Geographic Organization, Such As Europe, North America, Or Asia Pacific. Requires Admin Scope With Write Permissions.

Create Reject Reason

Add A New Rejection Reason Option.

Create Requisition

Submit A New Job Requisition For Approval. This Initiates The Hiring Approval Workflow, Requesting Permission To Fill A Position. Requires Location_id From List_locations. Optionally Use List_departments For Department_id. Note - Requires Requisitions Feature To Be Enabled On The Teamtailor Account.

Create Role

Create A New Job Role Category In The Organization. Roles Classify Jobs By Function Or Area Of Expertise Such As Engineering, Sales, Or Marketing.

Create Stage

Add A New Stage To A Job'S Hiring Pipeline. Use This To Customize The Recruitment Workflow With Additional Steps Like Technical Assessments, Panel Interviews, Or Reference Checks. Requires Write Permissions.

Create Team

Add A New Team For Organizing Users And Managing Access. Requires User_id From List_users As The Team Manager.

Create Team Membership

Add A User To A Team. Requires User_id From List_users And Team_id From List_teams.

Create Todo

Create A New Task Item To Track Recruitment Work. Todos Can Be Assigned To Team Members With Due Dates To Ensure Timely Completion Of Hiring Activities.

Create Transient Upload

Create A New Transient Upload.

Create Upload

Attach A File To A Candidate Profile Using A Public URL. Requires Candidate_id From List_candidates.

Create User

Add A New Team Member To The Teamtailor System. Use This To Onboard New Recruiters, Create Hiring Manager Accounts, Or Set Up Automated User Provisioning From Your HR System. Requires Admin Scope With Write Permissions.

Delete Candidate

Permanently Remove A Candidate And All Their Associated Data From The System. This Action Cannot Be Undone And Should Be Used With Caution. Requires Admin Scope With Elevated Write Permissions.

Delete Custom Field Value

Remove A Custom Field Value. Requires Id From List_custom_field_values.

Delete Department

Permanently Remove A Department From The Organizational Structure. Before Deleting, Ensure No Jobs Are Assigned To This Department Or Reassign Them First. Requires Write Permissions.

Delete Job

Permanently Remove A Job Posting And All Its Associated Data From The System. This Action Cannot Be Undone. Consider Archiving The Job Instead If You Want To Preserve Historical Data And Candidate Records. Requires Write Permissions.

Delete Location

Permanently Remove A Location From The Organization. Before Deleting, Ensure No Jobs Are Assigned To This Location Or Reassign Them First. Requires Write Permissions.

Delete Note

Permanently Remove A Note From A Candidate Or Job Application. Use This To Delete Outdated Information, Remove Inappropriate Comments, Or Clean Up Test Data. This Action Cannot Be Undone. Requires Admin Scope With Write Permissions.

Delete Reject Reason

Remove A Rejection Reason Option. Requires Reject Reason Id From List_reject_reasons.

Delete Role

Delete A Job Role Category From The Organization. Requires Role Id From List_roles.

Delete Stage

Remove A Stage From A Job'S Pipeline. Requires Stage Id From List_stages.

Delete Team

Remove A Team From The Organization. Requires Team Id From List_teams.

Delete Team Membership

Remove A User From A Team. Requires Membership Id From List_team_memberships.

Delete Todo

Permanently Remove A Task Item From The System. Requires Todo Id From List_todos. Use This To Clean Up Completed Or Obsolete Tasks.

Delete User

Remove A User Account From The System. Before Deleting, Reassign Any Jobs Owned By This User To Another Team Member. This Action Cannot Be Undone. Requires Admin Scope With Write Permissions.

Get Activity

Retrieve A Specific Activity Record By Its Unique Identifier. Activities Represent Actions Performed Within The Recruitment System Such As Candidate Stage Changes, Notes Added, Or Emails Sent. Requires Admin Scope.

Get Answer

Retrieve A Specific Answer By Its Unique Identifier. Returns The Complete Response Including The Answer Content And Metadata. Only Question And Candidate Relationships Can Be Included.

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 Can Be Used To Play Back Video Responses Submitted By Candidates.

Get Audit Event

Retrieve Detailed Information About A Specific Audit Event By ID. Returns The Complete Record Of A Single Change Including The Before And After State, The User Responsible, And Precise Timestamp.

Get Candidate

Retrieve Complete Information About A Specific Candidate Using Their Unique Identifier. Returns The Full Candidate Profile Including Personal Details, Contact Information, Application History, And Any Associated Documents Or Data. Available Include Options Are Activities, Division, Department, Role, Job-Applications, Questions, Answers, Locations, Regions, Uploads, Custom-Field-Values, Partner-Results, Form-Answers, Onboardings, And Interviews. Requires Admin Scope.

Get Company

Retrieve The Organization'S Company Profile And Account Settings. Returns Core Company Information Including Company Name, Career Site URL, Branding Settings, And Account Configuration. This Is The Central Resource For Understanding The Teamtailor Account Setup.

Get Custom Field

Retrieve A Specific Custom Field Definition By Its Unique Identifier. Requires Id Obtained From List_custom_fields.

Get Custom Field Option

Retrieve A Specific Custom Field Option By Its Unique Identifier. Returns The Option'S Value And The Custom Field It Belongs To.

Get Custom Field Select

Retrieve A Specific Select-Type Custom Field By Its Unique Identifier. Returns The Complete Field Configuration Including Its Available Options.

Get Custom Field Value

Retrieve A Specific Custom Field Value By Its Unique Identifier. Obtain The ID From List_custom_field_values Action.

Get Department

Retrieve Complete Information About A Specific Department Using Its Unique Identifier. Returns The Department Name, Associated Jobs, And Organizational Relationships.

Get Division

Retrieve Detailed Information About A Specific Division By Its Unique Identifier. Returns The Division Name And Related Organizational Data.

Get Form

Retrieve Detailed Information About A Specific Form By Its Unique Identifier. Returns The Form Configuration, Title, And Structure.

Get Form Answer

Retrieve A Specific Form Answer By Its Unique Identifier. Returns The Complete Response Including The Question Asked And The Candidate'S Answer.

Get Form Question

Retrieve A Specific Form Question By Its Unique Identifier. Returns The Complete Question Configuration Including Text, Type, And Validation Rules.

Get Interview

Retrieve Detailed Information About A Specific Interview By Its Unique Identifier. Returns The Complete Interview Record Including Scheduling Details, Participants, And Location. This Endpoint Is Read-Only.

Get Job

Retrieve Complete Information About A Specific Job Posting Using Its Unique Identifier. Returns The Full Job Details Including Title, Description, Requirements, Application Form Settings, And All Associated Data. Useful For Displaying Job Details On External Career Sites Or Integrating With Job Boards.

Get Job Application

Retrieve Complete Information About A Specific Job Application Using Its Unique Identifier. Returns The Full Application Details Including The Candidate'S Current Stage, Application History, Match Score, And Any Rejection Information. Requires Admin Scope.

Get Job Offer

Retrieve Detailed Information About A Specific Job Offer By Its Unique Identifier. Returns The Complete Offer Record Including Status, Terms, And Candidate Response. This Endpoint Is Read-Only.

Get Location

Retrieve Complete Information About A Specific Location Using Its Unique Identifier. Returns The Full Address Details, Geographic Coordinates If Available, And Associated Region Information.

Get Movement

Retrieve A Specific Movement By Its Unique Identifier. Returns The Complete Stage Transition Details Including From-Stage, To-Stage, And Rejection Status.

Get NPS Response

Retrieve A Specific NPS Response By Its Unique Identifier. Returns The Complete Feedback Record Including Score, Comments, And Submission Timestamp.

Get Note

Retrieve The Complete Content Of A Specific Note Using Its Unique Identifier. Returns The Full Note Text, Information About Who Wrote It, When It Was Created, And Which Candidate Or Application It Relates To. Requires Admin Scope.

Get Notification Setting

Retrieve A Specific Notification Setting By Its Unique Identifier. Returns The Complete Notification Preference Configuration For A User.

Get Onboarding

Retrieve Detailed Information About A Specific Onboarding Record By Its Unique Identifier. Returns The Complete Onboarding Status And New Hire Information.

Get Partner Result

Retrieve A Specific Partner Integration Result By Its Unique Identifier. Returns The Complete Result Data Including Scores, Status, And Any Detailed Findings From The Partner Application.

Get Question

Retrieve A Specific Question By ID.

Get Referral

Retrieve Detailed Information About A Specific Referral By ID.

Get Region

Retrieve A Specific Region By ID.

Get Reject Reason

Retrieve A Specific Rejection Reason By ID.

Get Requisition

Retrieve Detailed Information About A Specific Requisition By Its Unique Identifier. Returns The Complete Requisition Including Approval Status, Headcount, And Organizational Assignment.

Get Requisition Step Verdict

Retrieve A Specific Approval Verdict By Its Unique Identifier. Returns The Complete Decision Record Including The Approver, Their Decision, And Any Comments Provided.

Get Role

Retrieve A Specific Role By Its Unique Identifier. Returns The Role Name And Configuration.

Get Scorecard Criterium

Retrieve A Specific Evaluation Criterion By Its Unique Identifier. Returns The Criterion Name, Description, And Configuration.

Get Scorecard Pick

Retrieve A Specific Scorecard Pick By Its Unique Identifier. Returns The Criterion And Job Assignment Details.

Get Scorecard Score

Retrieve A Specific Scorecard Score By Its Unique Identifier. Returns The Complete Evaluation Including Rating, Criterion, Candidate, And Interviewer Details.

Get Stage

Retrieve Complete Information About A Specific Hiring Stage Using Its Unique Identifier. Returns The Stage Name, Type, Position In The Pipeline, And Which Job It Belongs To.

Get Stage Type

Retrieve A Specific Stage Type By Its Unique Identifier. Returns The Stage Type Name And Configuration.

Get Team

Retrieve Detailed Information About A Specific Team By ID.

Get Team Membership

Retrieve Details Of A Specific Team Membership By ID.

Get Todo

Retrieve A Specific Task Item By Its Unique Identifier. Returns The Complete Todo Including Description, Due Date, Completion Status, And Assigned User.

Get Transient Upload

Retrieve A Specific Transient Upload By ID.

Get Trigger

Retrieve A Specific Automation Trigger By Its Unique Identifier. Returns The Complete Trigger Configuration Including Conditions, Actions, And Associated Stage.

Get Upload

Retrieve A Specific Upload By ID.

Get User

Retrieve Complete Information About A Specific User Using Their Unique Identifier. Returns The User'S Profile Details, Role, Visibility Settings, And Relationships To Teams And Activities. Requires Admin Scope.

List Answers

Retrieve Candidate Responses To Application Questions. IMPORTANT - You Must Use Filter_question Parameter To Avoid Timeout Errors, As The Answers Endpoint Returns Massive Datasets That Will Cause Bad Gateway Errors Without Filtering. Only Question And Candidate Relationships Can Be Included.

List Audit Events

Retrieve The Complete Audit Trail Of All Changes Made Within The System. Audit Events Capture Every Modification To Candidates, Jobs, Applications, And Other Records, Including Who Made The Change, What Was Changed, And When It Occurred. Essential For Compliance Requirements, Security Audits, And Investigating Data History. Requires Admin Scope.

List Candidate Activities

Retrieve All Activities Associated With A Specific Candidate. This Returns A Chronological Feed Of Actions And Events Related To The Candidate, Such As Profile Updates, Stage Changes, Notes Added, Emails Sent, And Other Recruitment Activities. Requires Admin Scope.

List Candidates

Retrieve A Paginated List Of All Candidates In The Recruitment System. Candidates Are Individuals Who Have Applied For Positions Or Been Sourced By Recruiters. You Can Filter By Various Criteria Including Email Address, Department, Role, Location, And Date Ranges. Available Include Options Are Activities, Division, Department, Role, Job-Applications, Questions, Answers, Locations, Regions, Uploads, Custom-Field-Values, Partner-Results, Form-Answers, Onboardings, And Interviews. Requires Admin Scope.

List Custom Field Options

Retrieve All Available Options For Select-Type Custom Fields. Options Are The Individual Choices That Appear In Dropdown Menus For Single-Select And Multi-Select Custom Fields. Filter By Custom Field To See Options For A Specific Field.

List Custom Field Selects

Retrieve All Custom Field Select Definitions.

List Custom Field Values

Retrieve Custom Field Values For Specific Candidates Or Jobs.

List Custom Fields

Retrieve All Custom Field Definitions Configured In The System. Custom Fields Extend The Standard Candidate And Job Data Model With Additional Attributes Specific To Your Organization'S Needs, Such As Source Tracking, Skill Ratings, Or Compliance Information. Requires Admin Scope.

List Departments

Retrieve A Paginated List Of All Departments In The Organization. Departments Are Used To Categorize Jobs And Organize The Hiring Process By Team Or Business Unit. Useful For Building Career Site Filters And Syncing Organizational Structure.

List Divisions

Retrieve All Divisions Configured In The Organization. Divisions Represent The Highest Level Of Organizational Hierarchy, Grouping Multiple Departments Together. Examples Include Business Units Like Sales Division, Engineering Division, Or Regional Divisions Like North America And Europe. Requires Admin Scope.

List Form Answers

Retrieve Candidate Responses To Form Questions. Answers Contain The Actual Data Submitted By Candidates When Completing Application Forms Or Questionnaires.

List Form Questions

Retrieve All Questions Used Across Forms. Questions Define What Information Is Collected From Candidates, Including The Question Text, Type Such As Text, Select, Or File Upload, And Whether An Answer Is Required. Filter By Form To See Questions For A Specific Form.

List Forms

Retrieve All Forms Configured In The Organization. Forms Are Customizable Questionnaires Used To Collect Structured Information From Candidates During The Application Process. They Can Include Text Fields, Multiple Choice Questions, File Uploads, And More. Requires Admin Scope.

List Interviews

Retrieve All Scheduled Interviews Across The Organization. Interviews Are Meetings Arranged Between Candidates And Team Members During The Hiring Process. This Endpoint Is Read-Only As Interviews Are Created Through The Teamtailor UI Or Calendar Integrations. Requires Admin Scope.

List Job Activities

Retrieve All Activities Associated With A Specific Job Posting. This Returns A Chronological Feed Of Actions And Events Related To The Job, Such As Applications Received, Stage Changes, Candidate Movements, And Other Recruitment Activities. Requires Admin Scope.

List Job Applications

Retrieve A Paginated List Of All Job Applications In The System. Job Applications Represent Candidates Who Have Applied For Specific Positions And Track Their Progress Through The Hiring Pipeline. You Can Filter By Stage Type, Specific Candidate, Specific Job, And Date Ranges. Requires Admin Scope.

List Job Offers

Retrieve All Employment Offers That Have Been Extended To Candidates. Job Offers Track The Formal Offer Process Including Salary Details, Start Dates, And Candidate Responses. This Endpoint Is Read-Only As Offers Are Created Through The Teamtailor UI. Requires Admin Scope.

List Jobs

Retrieve A Paginated List Of All Job Postings In The System. Jobs Represent Open Positions That Candidates Can Apply For. You Can Filter By Status, Department, Location, And Other Criteria. The Jobs Visible Depend On Your API Key Scope Where Public Keys See Only Published Jobs While Admin Keys See All Jobs Including Drafts And Archived Positions.

List Locations

Retrieve A Paginated List Of All Office Locations In The Organization. Locations Represent Physical Offices Or Work Sites Where Jobs Are Available. They Appear As Filters On The Career Site Allowing Candidates To Find Positions Near Them.

List Movements

Retrieve A Paginated List Of All Job Application Movements Between Stages. Movements Track Candidate Progression Through The Hiring Pipeline, Including Stage Changes And Rejections. Filter By Job Application To See A Specific Candidate'S Journey Or By Rejection Status To Find Declined Applications.

List NPS Responses

Retrieve All Net Promoter Score Feedback Submitted By Candidates. NPS Measures Candidate Satisfaction With Your Hiring Process On A Scale Of 0 To 10, Categorizing Respondents As Detractors, Passives, Or Promoters. Filter By Candidate Or Job Application To See Specific Feedback. This Data Is Read-Only As Responses Are Submitted By Candidates Directly. Requires Admin Scope.

List Notes

Retrieve A Paginated List Of All Notes And Comments Recorded On Candidates And Their Job Applications. Notes Capture Recruiter Observations, Interview Feedback, And Important Information Gathered During The Hiring Process. Requires Admin Scope.

List Notification Settings

Retrieve Notification Preferences For All Users In The Organization. Notification Settings Control What Events Trigger Alerts And How They Are Delivered, Such As Email Notifications For New Applications Or In-App Alerts For Interview Reminders. Filter By User To See A Specific Team Member'S Preferences. Requires Admin Scope.

List Onboardings

Retrieve All Onboarding Records For Hired Candidates. Onboardings Track The New Hire Process From Offer Acceptance Through Their First Day And Beyond, Including Paperwork Completion, Equipment Setup, And Orientation Scheduling. Filter By Candidate To See Their Onboarding Status. Requires Admin Scope.

List Partner Results

Retrieve Results From Third-Party Partner Integrations. Partner Results Include Data From Assessment Platforms, Background Check Services, Video Interview Tools, And Other Integrated Applications. Filter By Candidate To See All Their External Assessment Results. Requires Admin Scope.

List Picked Questions

Retrieve The Mapping Of Questions To Specific Jobs. Picked Questions Represent Which Questions From The Library Have Been Selected For Each Job'S Application Form. To See Questions For A Specific Job, Use Get_job With Include=Picked-Questions Instead.

List Questions

Retrieve All Questions From The Organization'S Question Library. Questions Are Reusable Across Multiple Job Postings And Can Be Text Fields, Multiple Choice, File Uploads, Or Other Types. These Form The Building Blocks Of Application Forms And Screening Questionnaires. Requires Admin Scope.

List Referrals

Retrieve All Candidate Referrals Made By Employees. Referrals Track When Team Members Recommend Candidates For Open Positions, Enabling Reward Programs And Measuring The Effectiveness Of Employee Referral Initiatives. Requires Admin Scope.

List Regions

Retrieve All Geographic Regions Configured In The Organization. Regions Group Multiple Locations Together For Broader Geographic Organization, Such As Europe, North America, Or Asia Pacific. They Enable Candidates To Filter Jobs By Broader Geographic Area On The Career Site. Requires Admin Scope.

List Reject Reasons

Retrieve All Configured Rejection Reasons Available In The System. Rejection Reasons Provide Standardized Explanations For Why Candidates Were Not Selected Or Why They Withdrew From The Process. These Reasons Are Used For Analytics And Consistent Candidate Communication.

List Requisition Step Verdicts

Retrieve All Approval Decisions Made On Requisitions. Each Verdict Represents An Approver'S Decision At One Step Of The Requisition Approval Workflow, Recording Whether They Approved, Rejected, Or Are Still Pending. Filter By Requisition To See All Decisions For A Specific Hiring Request. Requires Admin Scope.

List Requisitions

Retrieve All Job Requisitions And Their Approval Status. Requisitions Are Formal Requests To Fill A Position, Often Requiring Approval From Managers Or HR Before A Job Posting Can Be Created. They Support Headcount Planning And Budget Control For Hiring. Requires Admin Scope.

List Roles

Retrieve All Job Role Categories Configured In The Organization. Roles Classify Jobs By Function Or Area Of Expertise Such As Engineering, Sales, Marketing, Or Customer Support. They Appear On Career Sites As Filters Helping Candidates Find Relevant Positions. Requires Admin Scope.

List Scorecard Criteria

Retrieve All Evaluation Criteria Available For Interview Scorecards. Criteria Are The Specific Attributes Or Competencies That Interviewers Rate Candidates On, Such As Technical Skills, Communication, Cultural Fit, Or Leadership Ability. Requires Admin Scope.

List Scorecard Picks

Retrieve The Mapping Of Evaluation Criteria To Specific Jobs. Scorecard Picks Define Which Criteria Should Be Used When Evaluating Candidates For Each Position, Allowing Different Jobs To Have Tailored Evaluation Frameworks. Filter By Job To See That Position'S Scorecard Configuration.

List Scorecard Scores

Retrieve All Candidate Evaluation Scores From Interview Scorecards. Scores Are The Actual Ratings Given By Interviewers When Assessing Candidates Against Specific Criteria. Requires Admin Scope.

List Stage Types

Retrieve All Available Stage Type Definitions That Categorize Stages In The Hiring Pipeline. Stage Types Include Inbox For New Applications, In Process For Active Candidates Being Evaluated, And Hired For Successful Candidates.

List Stages

Retrieve All Hiring Pipeline Stages Across Jobs. Stages Represent The Steps Candidates Progress Through During Recruitment, Such As Application Received, Phone Screen, Interview, Offer, And Hired. Filter By Job To See The Pipeline For A Specific Position.

List Team Memberships

Retrieve Team Membership Records Showing User-Team Associations.

List Teams

Retrieve All Teams Configured In The Organization. Teams Group Users Together For Permission Management And Collaborative Hiring. Team Membership Determines Which Candidates And Jobs Users Can Access. Requires Admin Scope.

List Todos

Retrieve All Task Items Assigned To Team Members. Todos Track Recruitment Action Items Such As Reviewing A Candidate, Scheduling An Interview, Or Following Up On A Reference Check. Filter By Assignee To See Tasks For A Specific User, By Candidate To See Candidate-Related Tasks, Or By Due Date To Find Overdue Items. Requires Admin Scope.

List Transient Uploads

Retrieve All Transient (Temporary) Uploads.

List Triggers

Retrieve All Automation Triggers Configured In The System. Triggers Automatically Execute Actions When Specific Events Occur, Such As Sending An Email When A Candidate Reaches A Certain Stage, Or Assigning A Task When An Application Is Received. Requires Admin Scope.

List Uploads

Retrieve All File Uploads Attached To Candidates. Uploads Include Resumes, Cover Letters, Portfolios, And Other Documents Submitted By Or For Candidates. Filter By Candidate To See All Their Attached Files Or By Job For Application-Specific Documents. Requires Admin Scope.

List User Activities

Retrieve All Activities Performed By A Specific User In The Recruitment System. This Returns A Chronological Feed Of Actions The User Has Taken, Such As Adding Notes, Moving Candidates Between Stages, Sending Emails, And Completing Tasks. Requires Admin Scope.

List Users

Retrieve A Paginated List Of All Users In The System. Users Include Recruiters, Hiring Managers, Administrators, And Other Team Members Involved In The Hiring Process. Each User Has A Role Determining Their Permissions And Capabilities. Requires Admin Scope.

Update Candidate

Modify An Existing Candidate'S Profile Information. Use This To Update Contact Details, Correct Information, Or Add Additional Data To A Candidate Record. Requires Admin Scope With Write Permissions.

Update Company

Update The Organization'S Company Profile Settings. Allows Modifying Company Name, Website, And Locale. Can Also Update The Manager Relationship By Providing A User ID. Requires Admin Scope With Write Permissions.

Update Custom Field

Update An Existing Custom Field Definition. Requires Id From List_custom_fields. Note That Api-Name Cannot Be Changed After Creation.

Update Custom Field Option

Update An Existing Custom Field Option. Allows Modifying The Display Value Of A Dropdown Choice.

Update Custom Field Select

Update An Existing Select-Type Custom Field Definition. Allows Modifying The Name Or API Name Of An Existing Select Or Multi-Select Field.

Update Custom Field Value

Modify An Existing Custom Field Value. Requires Id From List_custom_field_values Or Create_custom_field_value.

Update Department

Modify An Existing Department'S Information, Such As Renaming It. Useful For Organizational Restructuring Or Keeping Department Names In Sync With External HR Systems. Requires Write Permissions.

Update Job

Modify An Existing Job Posting. Use This To Update Job Details, Change The Status, Or Edit The Description. Commonly Used To Publish Draft Jobs, Archive Filled Positions, Or Update Job Requirements. Requires Write Permissions.

Update Job Application

Modify A Job Application To Update The Candidate'S Rejection Status. Use This To Mark Candidates As Rejected. Requires Admin Scope With Write Permissions.

Update Location

Modify An Existing Location'S Information Such As Its Name Or Address Details. Useful When Office Addresses Change Or Names Need Updating. Requires Write Permissions.

Update Note

Modify The Content Of An Existing Note. Use This To Correct Information, Add Additional Details, Or Update Feedback After Further Consideration. Requires Admin Scope With Write Permissions.

Update Reject Reason

Modify An Existing Rejection Reason. Requires Reject Reason Id From List_reject_reasons.

Update Requisition

Modify An Existing Requisition'S Details Such As Title, Headcount, Or Reason. Requires Requisition Id From List_requisitions. Note That Approval Status Changes May Be Handled Through Separate Workflow Actions. Note - Requires Requisitions Feature To Be Enabled On The Teamtailor Account.

Update Stage

Modify Stage Properties Including Name And Order. Requires Stage Id From List_stages.

Update Team

Update An Existing Team'S Information. Requires Team Id From List_teams.

Update Todo

Update An Existing Task Item'S Details Or Mark It As Completed. Requires Todo Id From List_todos. Set The Completed_at Timestamp To Mark A Task As Done.

Update User

Modify An Existing User'S Profile Information, Role, Or Visibility Settings. Use This To Update Names, Change Permission Levels, Or Control Visibility On The Career Site. Requires Admin Scope With Write Permissions.

No actions available.