Teamtailor API Directory

Teamtailor is a comprehensive recruitment software designed to streamline the hiring process, making it an indispensable tool for human resources and recruitment professionals. This all-in-one platform offers a suite of features that enhance the recruitment experience for both teams and candidates. By providing tools for job posting, candidate tracking, and communication, Teamtailor ensures a seamless and efficient hiring journey. Its user-friendly interface and robust functionalities make it a preferred choice for organizations looking to optimize their recruitment strategies.

​The Teamtailor API provides developers with robust tools to integrate and automate various recruitment and talent acquisition processes within their applications. Below are the key highlights of the Teamtailor API:

Key Features of the Teamtailor API:

• Data Management: The API provides endpoints to import, edit, and export information from your Teamtailor account, including jobs, candidates, departments, and locations. ​Teamtailor Support
• Authentication: Access is secured via API keys, which can be generated in the Teamtailor account settings under "Integrations" > "API keys." There are three types of keys with varying permissions
  • Public: Access to all public data available on the career site.​
  • Internal: Access to public and internal data, such as unlisted jobs.​
  • Admin: Full access to all account data.​
  Each key can have read, write, or read/write permissions.
• Partner and Job Board Integrations: Teamtailor provides specialized APIs for partners and job boards:​ partner.teamtailor.com
  • Partner API: Allows partners to retrieve webhooks with candidate data or update assessment results.
  • Job Board API: Enables job boards to integrate with Teamtailor using HTTP webhooks or XML feeds.

Getting Started with the Teamtailor API:

1. Generate an API Key:
   • Navigate to "Settings" > "Integrations" > "API keys" in your Teamtailor account.​
   • Click "+ New API Key" and select the appropriate permissions and scopes.​
   • Once created, the API key cannot be edited, only deleted.
2. Explore the API Documentation:
   • Review the official Teamtailor API documentation to understand available endpoints and data structures. ​Teamtailor API
3. Implement API Calls:
   • Use standard HTTP methods (GET, POST, PATCH, DELETE) to interact with the API.​
   • Include the API key in the Authorization header of your requests.​
   • Ensure your application handles responses and errors appropriately.​

‍

Teamtailor API Endpoints

Activities

• GET https://api.teamtailor.com/v1/activities/{id} : The 'Retrieve List of Activities' API allows users to fetch details of a specific activity by its ID.

Answers

• POST https://api.teamtailor.com/v1/answers : This API endpoint allows the creation of a new answer for a candidate to a specific question.
• GET https://api.teamtailor.com/v1/answers/{id} : This API endpoint is used to retrieve lists of audit events for a specific answer identified by its ID.

Audit Events

• GET https://api.teamtailor.com/v1/audit-events : This API retrieves lists of audit events from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/audit-events/{id} : This API retrieves a specific audit event by its ID.

Candidates

• POST https://api.teamtailor.com/v1/candidates : This API endpoint allows you to create a new candidate in the Teamtailor system.
• GET https://api.teamtailor.com/v1/candidates/{candidate_id} : The List Candidates API allows users to retrieve a list of candidates from the Teamtailor platform.
• PATCH https://api.teamtailor.com/v1/candidates/{id} : This API allows you to change the attributes or relationships of a candidate in the Teamtailor system.

Company

• PATCH https://api.teamtailor.com/v1/company : This API endpoint allows you to update the details of a company associated with the current API key.

Custom Field Options

• GET https://api.teamtailor.com/v1/custom-field-options : This API endpoint allows the creation of a new custom field option in the Teamtailor system.
• PATCH https://api.teamtailor.com/v1/custom-field-options/{custom-field-option_id} : This API endpoint allows you to update a custom field option in the Teamtailor system.

Custom Field Selects

• POST https://api.teamtailor.com/v1/custom-field-selects : This API endpoint allows you to create a new custom field select in the Teamtailor system.
• PATCH https://api.teamtailor.com/v1/custom-field-selects/{id} : The 'Update Custom Field Selects' API allows you to update the details of a specific custom field select by its ID.

Custom Field Values

• POST https://api.teamtailor.com/v1/custom-field-values : This API endpoint allows the creation of a new custom field value in the Teamtailor system.
• PATCH https://api.teamtailor.com/v1/custom-field-values/{id} : The 'Update Custom Field Value' API allows you to update the value of a custom field for a specific resource in Teamtailor.

Custom Fields

• GET https://api.teamtailor.com/v1/custom-fields : The List Custom Fields API allows you to retrieve a list of custom fields from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/custom-fields/{id} : This API retrieves a specific custom field by its ID.

Departments

• GET https://api.teamtailor.com/v1/departments : The List Departments API retrieves a list of departments from the Teamtailor platform.
• DELETE https://api.teamtailor.com/v1/departments/{id} : The Delete Department API allows you to delete a department by its ID.

Files

• POST https://api.teamtailor.com/v1/files : This API uploads a file to temporary storage and returns a transient URI that can be used in place of a public URL in some endpoints.

Job Applications

• POST https://api.teamtailor.com/v1/job-applications : This API endpoint allows the creation of a new job application in the Teamtailor system.
• PATCH https://api.teamtailor.com/v1/job-applications/{id} : This API allows you to change a candidate's attributes and relationships for a specific job application.

Job Offers

• GET https://api.teamtailor.com/v1/job-offers : This API endpoint retrieves lists of job offers from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/job-offers/{id} : The Show Job Offer API retrieves details of a specific job offer using its unique ID.

Jobs

• GET https://api.teamtailor.com/v1/jobs : The 'Create a New Job' API allows users to create a new job listing on the Teamtailor platform.
• GET https://api.teamtailor.com/v1/jobs/{id} : The 'Retrieve a Specific Job' API allows users to fetch detailed information about a specific job using its unique ID.

Locations

• GET https://api.teamtailor.com/v1/locations : The List Locations API retrieves a list of locations from the Teamtailor platform.
• PATCH https://api.teamtailor.com/v1/locations/{id} : This API endpoint allows updating a location's details in the Teamtailor system.

Notes

• POST https://api.teamtailor.com/v1/notes : This API endpoint allows the creation of a new note for a candidate in the Teamtailor system.
• GET https://api.teamtailor.com/v1/notes/{id} : This API endpoint retrieves a single note from the Teamtailor system.

Notification Settings

• GET https://api.teamtailor.com/v1/notification-settings : The List Notification Settings API allows clients to retrieve a list of notification settings for a user.
• GET https://api.teamtailor.com/v1/notification-settings/{id} : The Show Notification Setting API retrieves the notification settings for a specific user by ID.

NPS Responses

• GET https://api.teamtailor.com/v1/nps-response/{id} : The Show NPS Response API retrieves the details of a specific NPS (Net Promoter Score) response using its unique identifier.
• GET https://api.teamtailor.com/v1/nps-responses : The List NPS Responses API allows you to retrieve a list of Net Promoter Score (NPS) responses from the Teamtailor platform.

Partner Results

• GET https://api.teamtailor.com/v1/partner-results : The List Partner Results API allows users to retrieve a list of partner results from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/partner-results/<partner result uuid> : This API retrieves lists of answers by fetching partner results using a unique partner result UUID.

Picked Questions

• GET https://api.teamtailor.com/v1/picked-questions : The List Picked Questions API retrieves a list of picked questions from the Teamtailor platform.

Questions

• GET https://api.teamtailor.com/v1/questions : This API endpoint retrieves a list of questions from the Teamtailor platform.

Referrals

• GET https://api.teamtailor.com/v1/referrals : The List Referrals API allows users to retrieve a list of referrals from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/referrals/{id} : The Show Region API retrieves details of a specific referral by its ID.

Regions

• POST https://api.teamtailor.com/v1/regions : This API endpoint allows the creation of a new region in the system.

Reject Reasons

• POST https://api.teamtailor.com/v1/reject-reasons : The Create Reject Reason API allows users to create a new reject reason in the system.
• DELETE https://api.teamtailor.com/v1/reject-reasons/{id} : The Delete Reject Reason API allows you to delete a specific reject reason by its ID.

Requisition Step Verdicts

• GET https://api.teamtailor.com/v1/requisition-step-verdicts/{id} : The 'Show Requisition Step Verdicts' API retrieves the details of a specific requisition step verdict by its ID.

Requisitions

• GET https://api.teamtailor.com/v1/requisitions : The List Requisitions API allows users to retrieve a list of job requisitions from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/requisitions/{id} : The Show Requisition Details API retrieves detailed information about a specific requisition identified by its unique ID.

Roles

• GET https://api.teamtailor.com/v1/roles : The List Roles API allows users to retrieve a list of roles from the Teamtailor platform.
• DELETE https://api.teamtailor.com/v1/roles/{id} : This API endpoint is used to delete a role in the system.

Stage Types

• GET https://api.teamtailor.com/v1/stage-types : The List Stage Types API retrieves a list of stage types from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/stage-types/{id} : The 'Show Stage Type' API retrieves details of a specific stage type identified by its ID.

Stages

• GET https://api.teamtailor.com/v1/stages : This API endpoint retrieves lists of stages from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/stages/{id} : The Get Stage Details API retrieves detailed information about a specific stage in the Teamtailor system.

Team Memberships

• GET https://api.teamtailor.com/v1/team-memberships : The List Team Memberships API allows you to retrieve a list of team memberships from the Teamtailor platform.
• GET https://api.teamtailor.com/v1/team-memberships/{id} : The Show Team Membership API retrieves details of a specific team membership by its ID.

Teams

• GET https://api.teamtailor.com/v1/teams : The List Teams API allows you to retrieve a list of teams from the Teamtailor platform.
• DELETE https://api.teamtailor.com/v1/teams/{id} : This API endpoint is used to delete a team from the system.

Todos

• POST https://api.teamtailor.com/v1/todos : The Create Todo API allows users to create a new todo item in the system.
• PATCH https://api.teamtailor.com/v1/todos/{id} : The Update Todo API allows you to update the details of a specific todo item by its ID.

Triggers

• GET https://api.teamtailor.com/v1/triggers : This API endpoint retrieves lists of triggers from the Teamtailor platform.

Uploads

• GET https://api.teamtailor.com/v1/uploads : This API endpoint retrieves lists of uploads from the Teamtailor platform.

Users

• POST https://api.teamtailor.com/v1/users : This API endpoint allows the creation of a new user in the Teamtailor system.
• DELETE https://api.teamtailor.com/v1/users/{id} : The Delete User API allows an admin to delete a user from the system.

Teamtailot API FAQ's

Leverage Knit for Teamtailor API Integration

For quick and seamless access to Teamtailor API, Knit API offers a convenient Unified API solution. By integrating with Knit just once, you can go live with multiple ATS integrations in one go. Knit takes care of all the authentication, authorization, and ongoing integration maintenance, this approach not only saves time but also ensures a smooth and reliable connection to your Teamtailor API.