> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Teamtailor

> How to set up the Teamtailor connector, plus the actions and events that are available.

![Teamtailor](https://stackone-logos.com/api/teamtailor/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/teamtailor/changelog.md)

[106 actions](#actions) · [16 events](#events) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/teamtailor/guides/connector-profile/api-key.md)
>
> Uses an API key with a Public, Internal or Admin permission level. Admin level with Read/Write access gives full API fun...

Optionally, configure receiving Events for Teamtailor into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/teamtailor/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/teamtailor/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

admin:read

admin:read\_write

admin:write

internal:read

internal:read\_write

internal:write

public:read

public:read\_write

public:write

No scopes found

106 actions

ActionDescriptionRequired scopes

Get Activity`teamtailor_get_activity`

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

`admin:read`

List Candidate Activities`teamtailor_list_candidate_activities`

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

`admin:read`

List Job Activities`teamtailor_list_job_activities`

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

`admin:read`

List User Activities`teamtailor_list_user_activities`

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

`admin:read`

List Answers`teamtailor_list_answers`

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

`admin:read`

Get Answer`teamtailor_get_answer`

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

`admin:read`

Create Answer`teamtailor_create_answer`

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

`admin:write`

Get Answer Authenticated Video URL`teamtailor_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...

`admin:read`

List Candidates`teamtailor_list_candidates`

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

`admin:read`

Get Candidate`teamtailor_get_candidate`

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

`admin:read`

Create Candidate`teamtailor_create_candidate`

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

`admin:write`

Update Candidate`teamtailor_update_candidate`

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

`admin:read_write`

Delete Candidate`teamtailor_delete_candidate`

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

`admin:read_write`

Get Company`teamtailor_get_company`

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

`admin:read`

Update Company`teamtailor_update_company`

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

`admin:read_write`

List Custom Field Values`teamtailor_list_custom_field_values`

Retrieve custom field values for specific candidates or jobs.

`admin:read`

Get Custom Field Value`teamtailor_get_custom_field_value`

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

`admin:read`

Create Custom Field Value`teamtailor_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...

`admin:write`

Update Custom Field Value`teamtailor_update_custom_field_value`

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

`admin:read_write`

List Custom Fields`teamtailor_list_custom_fields`

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

`admin:read`

Get Custom Field`teamtailor_get_custom_field`

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

`admin:read`

Create Custom Field`teamtailor_create_custom_field`

Create a new custom field definition for candidates or jobs.

`admin:write`

Update Custom Field`teamtailor_update_custom_field`

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

`admin:read_write`

Get Custom Field Select`teamtailor_get_custom_field_select`

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

`admin:read`

Create Custom Field Select`teamtailor_create_custom_field_select`

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

`admin:write`

Update Custom Field Select`teamtailor_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...

`admin:read_write`

List Custom Field Options`teamtailor_list_custom_field_options`

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

`admin:read`

Get Custom Field Option`teamtailor_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...

`admin:read`

Create Custom Field Option`teamtailor_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...

`admin:write`

Update Custom Field Option`teamtailor_update_custom_field_option`

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

`admin:read_write`

List Divisions`teamtailor_list_divisions`

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

`admin:read`

Get Division`teamtailor_get_division`

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

`admin:read`

List Departments`teamtailor_list_departments`

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

`public:read``internal:read``admin:read`

Get Department`teamtailor_get_department`

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

`public:read``internal:read``admin:read`

Create Department`teamtailor_create_department`

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

`admin:write`

Update Department`teamtailor_update_department`

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

`admin:read_write`

Delete Department`teamtailor_delete_department`

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

`admin:read_write`

List Forms`teamtailor_list_forms`

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

`admin:read`

Get Form`teamtailor_get_form`

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

`admin:read`

List Form Questions`teamtailor_list_form_questions`

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

`admin:read`

Get Form Question`teamtailor_get_form_question`

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

`admin:read`

List Form Answers`teamtailor_list_form_answers`

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

`admin:read`

Get Form Answer`teamtailor_get_form_answer`

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

`admin:read`

List Interviews`teamtailor_list_interviews`

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

`admin:read`

Get Interview`teamtailor_get_interview`

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

`admin:read`

List Jobs`teamtailor_list_jobs`

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

`public:read``internal:read``admin:read`

Get Job`teamtailor_get_job`

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

`public:read``internal:read``admin:read`

Create Job`teamtailor_create_job`

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

`public:write``internal:write``admin:write`

Update Job`teamtailor_update_job`

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

`public:read_write``internal:read_write``admin:read_write`

Delete Job`teamtailor_delete_job`

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

`public:read_write``internal:read_write``admin:read_write`

List Job Applications`teamtailor_list_job_applications`

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

`admin:read`

Get Job Application`teamtailor_get_job_application`

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

`admin:read`

Create Job Application`teamtailor_create_job_application`

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

`admin:write`

Update Job Application`teamtailor_update_job_application`

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

`admin:read_write`

List Job Offers`teamtailor_list_job_offers`

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

`admin:read`

Get Job Offer`teamtailor_get_job_offer`

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

`admin:read`

List Locations`teamtailor_list_locations`

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

`public:read``internal:read``admin:read`

Get Location`teamtailor_get_location`

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

`public:read``internal:read``admin:read`

Create Location`teamtailor_create_location`

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

`admin:write`

Update Location`teamtailor_update_location`

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

`admin:read_write`

Delete Location`teamtailor_delete_location`

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

`admin:read_write`

List Notes`teamtailor_list_notes`

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

`admin:read`

Get Note`teamtailor_get_note`

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

`admin:read`

Create Note`teamtailor_create_note`

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

`admin:write`

Create Note On Application`teamtailor_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...

`admin:write`

Update Note`teamtailor_update_note`

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

`admin:read_write`

Delete Note`teamtailor_delete_note`

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

`admin:read_write`

List Onboardings`teamtailor_list_onboardings`

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

`admin:read`

Get Onboarding`teamtailor_get_onboarding`

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

`admin:read`

List Picked Questions`teamtailor_list_picked_questions`

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

`admin:read`

List Questions`teamtailor_list_questions`

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

`admin:read`

List Reject Reasons`teamtailor_list_reject_reasons`

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

`admin:read`

Get Reject Reason`teamtailor_get_reject_reason`

Retrieve a specific rejection reason by ID.

`admin:read`

Create Reject Reason`teamtailor_create_reject_reason`

Add a new rejection reason option.

`admin:write`

Update Reject Reason`teamtailor_update_reject_reason`

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

`admin:read_write`

Delete Reject Reason`teamtailor_delete_reject_reason`

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

`admin:read_write`

List Requisitions`teamtailor_list_requisitions`

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

`admin:read`

Get Requisition`teamtailor_get_requisition`

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

`admin:read`

Create Requisition`teamtailor_create_requisition`

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

`admin:write`

Update Requisition`teamtailor_update_requisition`

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

`admin:read_write`

List Roles`teamtailor_list_roles`

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

`admin:read`

Get Role`teamtailor_get_role`

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

`admin:read`

Create Role`teamtailor_create_role`

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

`admin:write`

Delete Role`teamtailor_delete_role`

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

`admin:read_write`

List Stages`teamtailor_list_stages`

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

`admin:read`

Get Stage`teamtailor_get_stage`

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

`admin:read`

Create Stage`teamtailor_create_stage`

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

`admin:write`

List Stage Types`teamtailor_list_stage_types`

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

`admin:read`

Get Stage Type`teamtailor_get_stage_type`

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

`admin:read`

List Teams`teamtailor_list_teams`

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

`admin:read`

Get Team`teamtailor_get_team`

Retrieve detailed information about a specific team by ID.

`admin:read`

Create Team`teamtailor_create_team`

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

`admin:write`

Update Team`teamtailor_update_team`

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

`admin:read_write`

Delete Team`teamtailor_delete_team`

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

`admin:read_write`

List Team Memberships`teamtailor_list_team_memberships`

Retrieve team membership records showing user-team associations.

`admin:read`

Get Team Membership`teamtailor_get_team_membership`

Retrieve details of a specific team membership by ID.

`admin:read`

Create Team Membership`teamtailor_create_team_membership`

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

`admin:write`

Delete Team Membership`teamtailor_delete_team_membership`

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

`admin:read_write`

List Users`teamtailor_list_users`

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

`admin:read`

Get User`teamtailor_get_user`

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

`admin:read`

Create User`teamtailor_create_user`

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

`admin:write`

Update User`teamtailor_update_user`

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

`admin:read_write`

Delete User`teamtailor_delete_user`

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

`admin:read_write`

List Uploads`teamtailor_list_uploads`

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

`admin:read`

Get Upload`teamtailor_get_upload`

Retrieve a specific upload by ID.

`admin:read`

Create Upload`teamtailor_create_upload`

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

`admin:write`

## Events

Tags

Select all
|
Clear

Audit Events

Candidates

Job Applications

Jobs

Users

Verification

Webhooks

No tags found

16 events

EventDescriptionTags

Webhook Ping`teamtailor_webhook_ping`Manual setup

Acknowledges Teamtailor requests that carry no event name (such as connection tests) without emitting an event.

Verification

Candidate Created Webhook`teamtailor_webhook_candidate_create`Manual setup

Processes the Teamtailor candidate.create webhook event, fired when a new candidate is created.

CandidatesWebhooks

Candidate Updated Webhook`teamtailor_webhook_candidate_update`Manual setup

Processes the Teamtailor candidate.update webhook event, fired when a candidate's email, name, phone, pitch, LinkedIn UR...

CandidatesWebhooks

Candidate Deleted Webhook`teamtailor_webhook_candidate_destroy`Manual setup

Processes the Teamtailor candidate.destroy webhook event, fired when a candidate is deleted.

CandidatesWebhooks

Job Created Webhook`teamtailor_webhook_job_create`Manual setup

Processes the Teamtailor job.create webhook event, fired when a new job is created.

JobsWebhooks

Job Updated Webhook`teamtailor_webhook_job_update`Manual setup

Processes the Teamtailor job.update webhook event, fired when a job's title, body, pitch, status, employment details, sa...

JobsWebhooks

Job Deleted Webhook`teamtailor_webhook_job_destroy`Manual setup

Processes the Teamtailor job.destroy webhook event, fired when a job is deleted.

JobsWebhooks

Job Application Created Webhook`teamtailor_webhook_job_application_create`Manual setup

Processes the Teamtailor job\_application.create webhook event, fired when a new job application is created.

Job ApplicationsWebhooks

Job Application Updated Webhook`teamtailor_webhook_job_application_update`Manual setup

Processes the Teamtailor job\_application.update webhook event, fired when a job application's stage, rejection, cover le...

Job ApplicationsWebhooks

Job Application Deleted Webhook`teamtailor_webhook_job_application_destroy`Manual setup

Processes the Teamtailor job\_application.destroy webhook event, fired when a job application is deleted.

Job ApplicationsWebhooks

User Created Webhook`teamtailor_webhook_user_create`Manual setup

Processes the Teamtailor user.create webhook event, fired when a new user is created.

UsersWebhooks

User Updated Webhook`teamtailor_webhook_user_update`Manual setup

Processes the Teamtailor user.update webhook event, fired when a Teamtailor user (recruiter, hiring manager or admin) is...

UsersWebhooks

User Deleted Webhook`teamtailor_webhook_user_destroy`Manual setup

Processes the Teamtailor user.destroy webhook event, fired when a user is deleted.

UsersWebhooks

Audit Event Created Webhook`teamtailor_webhook_audit_event_create`Manual setup

Processes the Teamtailor audit\_event.create webhook event, fired when a new audit log entry is recorded.

Audit EventsWebhooks

Audit Event Updated Webhook`teamtailor_webhook_audit_event_update`Manual setup

Processes the Teamtailor audit\_event.update webhook event, fired when an audit log entry is updated.

Audit EventsWebhooks

Audit Event Deleted Webhook`teamtailor_webhook_audit_event_destroy`Manual setup

Processes the Teamtailor audit\_event.destroy webhook event, fired when an audit log entry is deleted.

Audit EventsWebhooks


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