TeamTailor API Integration

These are the list of integration use cases supported by Knit for TeamTailor API as part of the ATS category

Delete a Location

ID: delete_a_location
Operation: write
Entities: location
Summary: This API endpoint is used to delete a location from the system. It requires the DELETE HTTP method and the URL endpoint 'https://api.teamtailor.com/v1/locations/{id}', where '{id}' is the ID of the location to be deleted. The request must include the 'Authorization' header with a valid token and the 'X-Api-Version' header specifying the API version. The response does not return any content.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Note

ID: delete_a_note
Operation: write
Entities: note
Summary: This API endpoint is used to delete a note identified by its ID. The request requires the DELETE HTTP method and must include the 'Authorization' header with a valid token and the 'X-Api-Version' header specifying the API version. The note ID is provided as a path parameter in the URL. A successful request will delete the specified note and return an empty response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a role

ID: delete_a_role
Operation: write
Entities: role
Summary: This API endpoint is used to delete a role in the system. It requires the role ID as a path parameter and authorization token in the headers. The API version must also be specified in the headers. Upon successful deletion, the API returns no content.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Team

ID: delete_a_team
Operation: write
Entities: team
Summary: This API endpoint is used to delete a team from the system. It requires the team ID as a path parameter. The request must include headers for authorization, API version, and content type. The authorization header must contain a valid token. The API version header specifies the version of the API being used. The content type header should be set to 'application/vnd.api+json'. The request does not return any response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Department

ID: delete_department
Operation: write
Entities: department
Summary: The Delete Department API allows you to delete a department by its ID. It requires an authorization token and the API version to be specified in the headers. The department ID is provided as a path parameter. The API does not return any response body upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Reject Reason

ID: delete_reject_reason
Operation: write
Entities: question, candidate, reject reason
Summary: The Delete Reject Reason API allows you to delete a specific reject reason by its ID. The API requires an authorization token and the API version to be specified in the headers. The ID of the reject reason to be deleted must be provided as a path parameter. Upon successful deletion, the API returns an empty response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Team Membership

ID: delete_team_membership
Operation: write
Entities: team, membership, team membership
Summary: The Delete Team Membership API allows you to remove a team membership by specifying its ID in the path parameters. The request requires an authorization token, API version, and content type in the headers. The endpoint does not return any response body upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Todo

ID: delete_todo
Operation: write
Entities: todo
Summary: The Delete Todo API allows users to delete a specific todo item by its ID. The request requires an Authorization token, the API version, and the content type to be specified in the headers. The ID of the todo item to be deleted must be included as a path parameter. This API does not return any response body upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User

ID: delete_user
Operation: write
Entities: user, job
Summary: The Delete User API allows an admin to delete a user from the system. The API requires an authorization token and the API version to be specified in the headers. The user ID to be deleted is specified as a path parameter. If the user is a recruiter for any jobs, they must be reassigned to another user before deletion. This can be done automatically by providing the 'assign_jobs_to_user_id' query parameter. The API does not return any response body upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Audit Events List

ID: get_audit_events_list
Operation: read
Entities: audit event
Summary: This API endpoint is used to retrieve lists of audit events for a specific answer identified by its ID. The request requires an Authorization token and the API version to be specified in the headers. The ID of the answer must be provided as a path parameter. The response will contain the list of audit events associated with the specified answer ID.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Custom Field Option

ID: get_create_new_custom_field_option
Operation: write
Entities: custom field, attribute, custom field option
Summary: This API endpoint allows the creation of a new custom field option in the Teamtailor system. It requires a GET request to the specified URL with headers for authorization and API version. The request body must include the type of the resource, the value of the custom field option, and the relationship to the custom field, including its ID and type. The response returns the ID, type, and links related to the newly created custom field option, along with its attributes and relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Job

ID: get_create_new_job
Operation: write
Entities: user, job, department
Summary: The 'Create a New Job' API allows users to create a new job listing on the Teamtailor platform. It requires the user to provide authorization via a token, specify the API version, and set the content type to 'application/vnd.api+json'. The request body must include the job's title, body, and user information, while the pitch and department/location details are optional. Upon successful creation, the API returns the job's ID, type, various URLs related to the job, and detailed attributes such as the job's status, title, and creation timestamp. The response also includes links to related resources like activities, department, and user.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Custom Field Options

ID: get_custom_field_options
Operation: read
Entities: option, custom field, list
Summary: This API endpoint retrieves lists of custom field options for a select or multi-select custom field. It requires an Authorization token, API version, and content type in the headers. The response includes a list of custom field options, each with an ID, type, and attributes such as name and value.
Input Fields: Input Fields
Output Fields: Output Fields

Show Custom Field Value

ID: get_custom_field_value
Operation: read
Entities: owner, custom field
Summary: This API endpoint retrieves the details of a specific custom field value by its ID. The request requires an authorization token and the API version to be specified in the headers. The ID of the custom field value must be provided as a path parameter. The response includes the ID, type, and attributes of the custom field value, as well as links to related resources such as the custom field and owner.
Input Fields: Input Fields
Output Fields: Output Fields

List Candidates

ID: get_list_candidates
Operation: read
Entities: role, candidate, department
Summary: The List Candidates API allows users to retrieve a list of candidates from the Teamtailor platform. The API supports various query parameters for filtering candidates by email, department, role, locations, regions, and creation or update dates. It also allows sorting by candidate attributes. The response includes detailed information about each candidate, including their attributes and relationships with other resources such as activities, department, role, regions, job applications, questions, answers, locations, uploads, custom field values, and partner results. The API requires an authorization token and specifies the API version in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

List Custom Fields

ID: get_list_custom_fields
Operation: read
Entities: custom field, custom field value, custom field option
Summary: The List Custom Fields API allows you to retrieve a list of custom fields from the Teamtailor platform. This API uses the GET method and requires an Authorization token and an API version in the headers. The response includes an array of custom fields, each with attributes such as id, type, api-name, name, field-type, created-at, and updated-at. Relationships to custom field values and options are also provided, along with pagination metadata and links to navigate through pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Departments

ID: get_list_departments
Operation: read
Entities: role, team, department
Summary: The List Departments API retrieves a list of departments from the Teamtailor platform. It requires an Authorization token and an API version in the headers. The response includes an array of department objects, each with an ID, type, links, attributes, and relationships to roles and teams. The meta section provides additional information such as the singular and plural names of the resource, the total record count, and the number of pages. Links to the first and last pages of the results are also included.
Input Fields: Input Fields
Output Fields: Output Fields

List Locations

ID: get_list_locations
Operation: read
Entities: location, team
Summary: The List Locations API retrieves a list of locations from the Teamtailor platform. It requires an Authorization token and an API version in the headers. The response includes details about each location such as address, city, country, email, whether it is a headquarters, phone number, and ZIP code. It also provides links to related teams and pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

List Notification Settings

ID: get_list_notification_settings
Operation: read
Entities: notification setting, user
Summary: The List Notification Settings API allows clients to retrieve a list of notification settings for a user. The API requires an authorization token and API version in the headers. The response includes an array of notification settings, each with attributes such as email notification status and notification key, as well as links to related user resources. The response also includes metadata about the total number of records and pages, along with pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

List NPS Responses

ID: get_list_nps_responses
Operation: read
Entities: nps response, job application, candidate
Summary: The List NPS Responses API allows you to retrieve a list of Net Promoter Score (NPS) responses from the Teamtailor platform. This API requires an Authorization token and an API version header. The response includes details such as the feedback, score, and timestamps for each NPS response, as well as links to related resources like job applications, candidates, and stages. The response also provides pagination information through meta and links objects.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve List of Activities

ID: get_list_of_activities
Operation: read
Entities: candidate, activity, job
Summary: The 'Retrieve List of Activities' API allows users to fetch details of a specific activity by its ID. The API requires an authorization token and API version to be specified in the headers. The path parameter 'id' is required to identify the specific activity. The response includes the activity's attributes such as 'code', 'created-at', and 'data', as well as relationships to candidate, job, and user, each with their respective links.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve List of Questions

ID: get_list_of_questions
Operation: read
Entities: question, alternative, meta
Summary: This API endpoint retrieves a list of questions from the Teamtailor platform. The request requires an authorization token, API version, and content type headers. Optional query parameters include 'include' for specifying related entities to include in the response and 'sort' for sorting the list by upload attributes. The response contains an array of question objects, each with attributes such as title, description, question type, and alternatives. The response also includes metadata about the total number of records and pages, as well as links to the first and last pages of results.
Input Fields: Input Fields
Output Fields: Output Fields

List Partner Results

ID: get_list_partner_results
Operation: read
Entities: partner result, candidate, job
Summary: The List Partner Results API allows users to retrieve a list of partner results from the Teamtailor platform. The API uses the GET method and requires an authorization token, API version, and content type in the headers. Users can include additional relations in the response, filter results by candidate, and sort the list by any partner result attributes using query parameters. The response includes data about each partner result, such as its ID, type, attributes like assessment score, creation date, status, and relationships with candidates and jobs. The response also provides metadata about the number of records and pages, as well as links to navigate through the pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Picked Questions

ID: get_list_picked_questions
Operation: read
Entities: question, link, meta
Summary: The List Picked Questions API retrieves a list of picked questions from the Teamtailor platform. It requires an authorization token and API version in the headers. The response includes details about each picked question, such as its ID, type, and whether it is mandatory. Additionally, it provides links to the question itself and related resources. The response also contains metadata about the total number of records and pages, along with pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

List Referrals

ID: get_list_referrals
Operation: read
Entities: referral, candidate, department
Summary: The List Referrals API allows users to retrieve a list of referrals from the Teamtailor platform. The API supports filtering by various attributes such as candidate, department, email, job, phone, role, and user. It also allows sorting by any referral attribute. The response includes detailed information about each referral, including attributes like comment, creation timestamp, email, name, and phone, as well as relationships to candidate, department, job, role, and user. The API requires an authorization token and API version in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

List Regions

ID: get_list_regions
Operation: read
Entities: location, region
Summary: The List Regions API retrieves a list of regions from the Teamtailor platform. It requires an Authorization token and an API version in the headers. The response includes details about each region, such as its ID, name, creation timestamp, and links to related resources. The response also contains metadata about the total number of records and pages, as well as pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

List Reject Reasons

ID: get_list_reject_reasons
Operation: read
Entities: job application, reject reason
Summary: The List Reject Reasons API allows users to retrieve a list of reject reasons from the Teamtailor platform. The API requires an authorization token and API version to be specified in the headers. The response includes an array of reject reasons, each with an ID, type, links, attributes (such as reason and whether it was rejected by the company), and relationships to job applications. The response also includes metadata about the total number of records and pages, as well as links to navigate through the pages of results.
Input Fields: Input Fields
Output Fields: Output Fields

List Requisitions

ID: get_list_requisitions
Operation: read
Entities: user, requisition, job
Summary: The List Requisitions API allows users to retrieve a list of job requisitions from the Teamtailor platform. The API requires an Authorization token and an API version to be specified in the headers. The response includes detailed information about each requisition, such as job title, description, country, salary details, number of openings, and status. Additionally, it provides links to related resources such as location, department, role, recruiter, user, requisition step verdicts, and jobs. The response also includes metadata about the total number of records and pages, as well as pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

List Roles

ID: get_list_roles
Operation: read
Entities: role, team, department
Summary: The List Roles API allows users to retrieve a list of roles from the Teamtailor platform. It requires an Authorization token, API version, and content type in the headers. The response includes an array of role objects, each containing details such as role ID, name, and links to related resources like department and teams. The response also includes metadata about the total number of records and pages, as well as links to navigate through pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Stage Types

ID: get_list_stage_types
Operation: read
Entities: stage type, category, stage
Summary: The List Stage Types API retrieves a list of stage types from the Teamtailor platform. It requires an authorization token and API version in the headers. The response includes an array of stage types, each with an ID, type, links, attributes, and relationships. The attributes include the category of the stage type, and the relationships provide links to related stages. The response also includes metadata about the total number of records and pages, as well as links to the first and last pages of the results.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Memberships

ID: get_list_team_memberships
Operation: read
Entities: user, team, team membership
Summary: The List Team Memberships API allows you to retrieve a list of team memberships from the Teamtailor platform. The API endpoint is accessed via a GET request to 'https://api.teamtailor.com/v1/team-memberships'. You must include the 'Authorization' header with a valid token, the 'X-Api-Version' header specifying the API version, and the 'Content-Type' header set to 'application/vnd.api+json'. Optionally, you can include a 'include' query parameter to specify related resources to include in the response, such as 'user' or 'team'. The response includes a list of team memberships, each with its ID, type, links, and relationships to users and teams. The response also includes metadata about the total number of records and pages, as well as links to the first and last pages of results.
Input Fields: Input Fields
Output Fields: Output Fields

List Teams

ID: get_list_teams
Operation: read
Entities: user, team, department
Summary: The List Teams API allows you to retrieve a list of teams from the Teamtailor platform. It requires an Authorization token, API version, and content type in the headers. The response includes a list of teams with details such as team ID, name, emoji, and relationships with users, departments, locations, and roles. The response also provides pagination information with record and page counts, and links to the first and last pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Todos

ID: get_list_todos
Operation: read
Entities: assignee, todo, assigner
Summary: The List Todos API allows users to retrieve a list of todos from the Teamtailor platform. The API supports filtering by assignee, assigner, candidate, due date, and user, as well as sorting by any todo attribute. The response includes detailed information about each todo, including its attributes and relationships to other entities such as assignee, assigner, candidate, and user. The API requires an Authorization token and an API version header for authentication and versioning.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Answers

ID: get_lists_of_answers
Operation: read
Entities: question, candidate, answer
Summary: This API endpoint retrieves lists of answers from the Teamtailor platform. It uses the GET method and requires an Authorization token and an API version in the headers. The endpoint URL is 'https://api.teamtailor.com/v1/answers'. Optionally, a query parameter 'include' can be used to specify a comma-separated list of relations to include in the response, such as 'candidate' and 'question'. The response includes a list of answers, each with attributes like 'boolean', 'choices', 'updated-at', 'range', 'text', and 'video-token'. It also includes relationships to 'question' and 'candidate', with links to related resources. The response metadata provides the total record count and page count, and links to the first and last pages of the results.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Audit Events

ID: get_lists_of_audit_events
Operation: read
Entities: meta, link, audit event
Summary: This API retrieves lists of audit events from the Teamtailor platform. It requires an authorization token and the API version to be specified in the headers. The response includes an array of audit events, metadata about the total number of records and pages, and links to the first and last pages of results.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Custom Fields

ID: get_lists_of_custom_fields
Operation: read
Entities: owner, custom field, custom field value
Summary: This API endpoint retrieves lists of custom fields from the Teamtailor platform. It uses the GET method and requires an authorization token and API version in the headers. Optional query parameters include 'filter[field-type]' to filter by field type and 'filter[custom-field]' to filter by a custom field ID. The response includes data about custom field values, including their ID, type, attributes, and relationships, as well as metadata about the number of records and pages.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Job Applications

ID: get_lists_of_job_applications
Operation: read
Entities: candidate, stage, job
Summary: This API endpoint retrieves lists of job applications from the Teamtailor platform. It uses the GET method and requires authorization via a token. The endpoint allows filtering of job applications based on various criteria such as stage type, creation date, update date, and stage change date. It also supports sorting and including related entities like stage and candidate in the response. The response includes detailed information about each job application, including attributes like creation date, update date, and relationships to other entities such as candidate, job, stage, and reject reason. The response also provides pagination links and metadata about the total number of records and pages.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Job Offers

ID: get_lists_of_job_offers
Operation: read
Entities: job offer, job application, user
Summary: This API endpoint retrieves lists of job offers from the Teamtailor platform. It requires an Authorization token and an API version in the headers. The response includes a list of job offers with details such as creation date, status, salary, and start date. Each job offer also includes links to related resources like the user and job application. The response metadata provides the total record count and page count, along with pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Jobs

ID: get_lists_of_jobs
Operation: read
Entities: location, job, department
Summary: The 'Retrieve Lists of Jobs' API endpoint allows users to fetch a list of job postings from the Teamtailor platform. The endpoint supports various query parameters for filtering the jobs based on status, department, role, location, tags, and more. Users can also sort the results and include additional related data such as department and role. The API requires an authorization token and specifies the API version and content type in the headers. The response includes detailed information about each job, including attributes like title, status, and creation date, as well as links to related resources and pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Notes

ID: get_lists_of_notes
Operation: read
Entities: user, candidate, note
Summary: This API endpoint retrieves lists of notes from the Teamtailor platform. It requires an authorization token and an API version to be specified in the headers. The response includes a list of notes, each with details such as note content, creation and update timestamps, candidate and user IDs, and links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Stages

ID: get_lists_of_stages
Operation: read
Entities: job application, stage, job
Summary: This API endpoint retrieves lists of stages from the Teamtailor platform. It uses the GET method and requires an Authorization token and API version in the headers. The endpoint supports optional query parameters such as 'include' to specify related entities to include in the response, 'sort' to order the stages by attributes, and 'filter' options to filter stages by job or stage-type. The response includes detailed information about each stage, including its attributes, relationships, and pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Triggers

ID: get_lists_of_triggers
Operation: read
Entities: trigger, user, stage
Summary: This API endpoint retrieves lists of triggers from the Teamtailor platform. It uses the GET method and requires an authorization token and API version in the headers. Optional query parameters include 'include' for specifying related resources to include in the response and 'sort' for sorting the list by trigger attributes. The response includes data about each trigger, such as its ID, type, creation and update timestamps, trigger type, and serialized data. It also includes relationships, such as the stage, and pagination links and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Uploads

ID: get_lists_of_uploads
Operation: read
Entities: upload, candidate, job
Summary: This API endpoint retrieves lists of uploads from the Teamtailor platform. It uses the GET method and requires authorization headers. The request can include optional query parameters such as 'include' to specify related entities to include in the response, 'sort' to determine the order of the uploads, and 'filter[job]' to filter uploads by job. The response includes data about each upload, such as its ID, type, URL, file name, and relationships to candidates and jobs. Metadata about the number of records and pages is also provided, along with pagination links.
Input Fields: Input Fields
Output Fields: Output Fields

Show Location Details

ID: get_location_details
Operation: read
Entities: location, team, meta
Summary: This API retrieves the details of a specific location using its unique identifier. The request requires an authorization token and the API version number in the headers. The path parameter 'id' is mandatory and specifies the location to be retrieved. The response includes detailed information about the location, such as its address, city, country, email, phone number, and whether it is the headquarters. It also provides links to related teams and metadata about all locations.
Input Fields: Input Fields
Output Fields: Output Fields

Show Notification Setting

ID: get_notification_setting
Operation: read
Entities: notification setting, user
Summary: The Show Notification Setting API retrieves the notification settings for a specific user by ID. It requires an authorization token and API version in the headers. The response includes the notification setting ID, type, links, attributes such as email notification status and notification key, and relationships to the user.
Input Fields: Input Fields
Output Fields: Output Fields

Show NPS Response

ID: get_nps_response
Operation: read
Entities: nps response, job application, candidate
Summary: The Show NPS Response API retrieves the details of a specific NPS (Net Promoter Score) response using its unique identifier. The API requires an authorization token and the API version in the headers. The path parameter 'id' is mandatory and represents the unique identifier of the NPS response. The response includes detailed information about the NPS response such as creation and update timestamps, feedback, score, and relationships to job application, candidate, and stage.
Input Fields: Input Fields
Output Fields: Output Fields

Show Requisition Details

ID: get_requisition_details
Operation: read
Entities: job, requisition, department
Summary: The Show Requisition Details API retrieves detailed information about a specific requisition identified by its unique ID. The request requires an authorization token and API version in the headers. The response includes the requisition's attributes such as job title, description, country, salary details, number of openings, and status. It also provides links to related resources like location, department, role, recruiter, user, requisition step verdicts, and jobs.
Input Fields: Input Fields
Output Fields: Output Fields

Show Requisition Step Verdicts

ID: get_requisition_step_verdicts
Operation: read
Entities: verdict, user, requisition
Summary: The 'Show Requisition Step Verdicts' API retrieves the details of a specific requisition step verdict by its ID. It requires an authorization token and API version in the headers. The endpoint URL includes a path parameter for the ID of the requisition step verdict. The response includes the ID, type, links, attributes such as status, requisition step index, and updated timestamp, and relationships including links to the user associated with the verdict.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Single Note

ID: get_retrieve_a_single_note
Operation: read
Entities: user, candidate, note
Summary: This API endpoint retrieves a single note from the Teamtailor system. It requires the note ID as a path parameter and uses a GET method. The request must include an Authorization token and the API version in the headers. The response includes detailed information about the note, such as its content, creation and update timestamps, associated candidate and user IDs, and links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Answers

ID: get_retrieve_lists_of_answers
Operation: read
Entities: partner result, candidate, job
Summary: This API retrieves lists of answers by fetching partner results using a unique partner result UUID. The request requires an Authorization token and an API version header. The response includes detailed information about the partner result, such as its ID, type, creation timestamp, status, and relationships to candidate and job entities. The response also provides links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lists of Users

ID: get_retrieve_lists_of_users
Operation: read
Entities: location, user, department
Summary: This API endpoint retrieves a list of users from the Teamtailor platform. It supports filtering by email, department, and external ID, as well as sorting by user attributes. The response includes user details such as name, email, role, and various profile links. Relationships to activities, department, location, jobs, teams, and notification settings are also provided. The API requires an authorization token and specifies the API version and content type in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

Show a Role

ID: get_show_a_role
Operation: read
Entities: role, team, department
Summary: The 'Show a Role' API endpoint retrieves detailed information about a specific role identified by its ID. The request requires an Authorization token and the API version in the headers. The role ID is specified as a path parameter. The response includes the role's ID, type, name, and links to related resources such as department and teams. Additionally, meta information about all roles is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Show Company

ID: get_show_company
Operation: read
Entities: company, manager
Summary: The Show Company API endpoint retrieves the company information associated with the current API key. It requires an Authorization token and an API version in the headers. The response includes the company's unique ID, type, links, attributes such as locale, website, and name, and relationships including links to the manager.
Input Fields: Input Fields
Output Fields: Output Fields

Show Department

ID: get_show_department
Operation: read
Entities: role, team, department
Summary: The Show Department API retrieves details of a specific department identified by its ID. It requires an authorization token and API version in the headers. The response includes the department's ID, type, name, and links to related roles and teams. The meta section provides textual descriptions of the resource.
Input Fields: Input Fields
Output Fields: Output Fields

Show Job Application

ID: get_show_job_application
Operation: read
Entities: job application, candidate, job
Summary: The Show Job Application API retrieves detailed information about a specific job application using its unique ID. The request requires an authorization token and the API version in the headers. The path parameter 'id' is mandatory and specifies the job application's ID. The response includes the job application's attributes such as creation date, update date, and stage change date, as well as relationships to candidate, job, stage, and reject reason, each with self and related links.
Input Fields: Input Fields
Output Fields: Output Fields

Show Job Offer

ID: get_show_job_offer
Operation: read
Entities: job offer, job application, user
Summary: The Show Job Offer API retrieves details of a specific job offer using its unique ID. The request requires an Authorization token and the API version in the headers. The path parameter 'id' is mandatory and specifies the job offer's ID. The response includes the job offer's ID, type, creation date, sent date, status, and detailed messages for acceptance and rejection. It also provides links to related resources such as the user and job application.
Input Fields: Input Fields
Output Fields: Output Fields

Show Referral

ID: get_show_referral
Operation: read
Entities: referral, candidate, department
Summary: The Show Referral API retrieves detailed information about a specific referral using its ID. The request requires an Authorization token and an API version header. The response includes the referral's ID, type, attributes such as name and creation date, and relationships to other entities like candidate, department, job, role, and user. Each relationship includes links to access related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Show Region

ID: get_show_region
Operation: read
Entities: referral, candidate, department
Summary: The Show Region API retrieves details of a specific referral by its ID. It requires an authorization token and API version in the headers. The endpoint includes a path parameter for the referral ID. The response includes the referral's attributes such as name, creation date, and relationships to candidate, department, job, role, and user, each with self and related links.
Input Fields: Input Fields
Output Fields: Output Fields

Show Reject Reason

ID: get_show_reject_reason
Operation: read
Entities: job application, reject reason
Summary: The 'Show Reject Reason' API endpoint retrieves the details of a specific reject reason by its ID. It requires an authorization token and API version in the headers. The response includes the reject reason's ID, type, links, attributes such as the reason for rejection and whether it was rejected by the company, and relationships to job applications.
Input Fields: Input Fields
Output Fields: Output Fields

Show Stage Type

ID: get_show_stage_type
Operation: read
Entities: stage type, stage, relationship
Summary: The 'Show Stage Type' API retrieves details of a specific stage type identified by its ID. The request requires an authorization token and API version in the headers. The response includes the stage type's ID, type, category, and links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Show Team Details

ID: get_show_team_details
Operation: read
Entities: user, team, department
Summary: The Show Team Details API retrieves detailed information about a specific team identified by its unique ID. The request requires an authorization token and specifies the API version in the headers. The response includes the team's attributes such as name, emoji, and department status, as well as relationships to users, departments, locations, and roles, each with links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Show Team Membership

ID: get_show_team_membership
Operation: read
Entities: user, team, team membership
Summary: The Show Team Membership API retrieves details of a specific team membership by its ID. It requires an Authorization token, API version, and content type in the headers. The path parameter 'id' specifies the team membership to retrieve. The response includes the team membership ID, type, and links to related resources such as the user and team associated with the membership.
Input Fields: Input Fields
Output Fields: Output Fields

Show Todo

ID: get_show_todo
Operation: read
Entities: user, candidate, todo
Summary: The Show Todo API retrieves the details of a specific todo item identified by its ID. The request requires an Authorization token and the API version to be specified in the headers. The ID of the todo item is provided as a path parameter. The response includes the todo item's ID, type, creation timestamp, and value, along with links to related resources such as assignee, assigner, candidate, and user.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Specific Audit Event

ID: get_specific_audit_event
Operation: read
Entities: source, actor, audit event
Summary: This API retrieves a specific audit event by its ID. The request requires an Authorization token and the API version in the headers. The path parameter 'id' specifies the audit event to retrieve. The response includes details about the audit event such as the action performed, actor details, source information, and the timestamp of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Specific Candidate

ID: get_specific_candidate
Operation: read
Entities: role, candidate, department
Summary: This API retrieves a specific candidate's details from the Teamtailor platform. The request requires the candidate's ID as a path parameter and includes headers for authorization and API version. The response provides detailed information about the candidate, including personal attributes such as name, email, and creation date, as well as links to related resources like activities, department, and job applications.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Specific Custom Field

ID: get_specific_custom_field
Operation: read
Entities: custom field, custom field value
Summary: This API retrieves a specific custom field by its ID. The request requires an authorization token and the API version in the headers. The path parameter 'id' is required to specify the custom field to retrieve. The response includes the custom field's details such as its API name, name, field type, creation and update timestamps, and links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Specific Job

ID: get_specific_job
Operation: read
Entities: location, job, department
Summary: The 'Retrieve a Specific Job' API allows users to fetch detailed information about a specific job using its unique ID. The API requires an authorization token and API version in the headers. The job ID is a required path parameter. The response includes comprehensive details about the job, such as its title, status, description, and various URLs related to the job posting. It also provides links to related resources like activities, department, role, and more. The response is structured in a JSON format with 'data' and 'meta' sections, where 'data' contains the job details and 'meta' provides additional navigation texts.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Specific Stage

ID: get_specific_stage
Operation: read
Entities: trigger, job application, stage
Summary: This API endpoint retrieves a specific stage from the Teamtailor platform. The request requires an authorization token, API version, and content type in the headers. The stage ID is specified as a path parameter. Optionally, a comma-separated list of relations can be included in the query parameters to include additional related data in the response. The response includes detailed information about the stage, such as its creation and update timestamps, name, type, order, and counts of active and rejected job applications. It also provides links to related resources such as job applications, triggers, job, and stage type.
Input Fields: Input Fields
Output Fields: Output Fields

Get Stage Details

ID: get_stage_details
Operation: read
Entities: trigger, stage, job
Summary: The Get Stage Details API retrieves detailed information about a specific stage in the Teamtailor system. The API requires an authorization token and API version in the headers, and the stage ID as a path parameter. The response includes the stage's ID, type, creation and update timestamps, name, stage type, order, and counts of active and rejected job applications. It also provides links to related job applications, triggers, and job relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Details

ID: get_user_details
Operation: read
Entities: user, job, department
Summary: This API endpoint retrieves the details of a specific user by their ID from the Teamtailor platform. The request requires an authorization token and the API version to be specified in the headers. The user ID is a required path parameter. The response includes detailed information about the user, such as their name, email, role, and various profile links. It also provides links to related resources like activities, department, location, jobs, teams, and notification settings.
Input Fields: Input Fields
Output Fields: Output Fields

Change a Candidate's Attributes and Relationships

ID: patch_candidates_attributes_and_relationships
Operation: write
Entities: job application, candidate, job
Summary: This API allows you to change a candidate's attributes and relationships for a specific job application. The request requires the job application ID as a path parameter and includes headers for authorization, API version, and content type. The request body should contain the job application ID, the type of resource, and any attributes to be updated, such as the cover letter. The response includes the updated job application details, including attributes like the cover letter, creation and update timestamps, and relationships to candidate, job, stage, and reject reason.
Input Fields: Input Fields
Output Fields: Output Fields

Change Candidate Attributes/Relationships

ID: patch_change_candidate_attributes_relationships
Operation: write
Entities: attribute, candidate, relationship
Summary: This API allows you to change the attributes or relationships of a candidate in the Teamtailor system. The request is made using the PATCH method to the endpoint 'https://api.teamtailor.com/v1/candidates/{id}', where '{id}' is the ID of the candidate to be updated. The request headers must include an Authorization token, the API version, and the content type. The request body should contain the candidate's ID, the type 'candidates', and the attributes to be updated, such as the candidate's first name. The response includes the updated candidate data, including attributes like first name, email, and relationships such as activities, department, and role.
Input Fields: Input Fields
Output Fields: Output Fields

Change a user's attributes/relationships

ID: patch_change_user_attributes_relationships
Operation: write
Entities: user, job, department
Summary: This API allows you to change a user's attributes and relationships in the Teamtailor system. The PATCH request is sent to the endpoint 'https://api.teamtailor.com/v1/users/{id}', where '{id}' is the ID of the user to be updated. The request must include headers for authorization, API version, and content type. The body of the request should contain the user's ID, the type 'users', and the attributes to be updated, such as 'title' and 'name'. The response includes the updated user data, including attributes like 'name', 'title', 'role', and relationships such as 'activities', 'department', 'location', 'jobs', 'teams', and 'notification-settings'.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Location

ID: patch_update_a_location
Operation: write
Entities: location, team
Summary: This API endpoint allows updating a location's details in the Teamtailor system. It requires an admin scope for access. The request is made using the PATCH method to the endpoint 'https://api.teamtailor.com/v1/locations/{id}', where '{id}' is the ID of the location to be updated. The request headers must include an authorization token, API version, and content type. The request body should contain the location's ID, type, and attributes to be updated, such as the name. The response includes the updated location details, including address, city, country, email, headquarters status, name, phone, and zip code, along with links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Update Company Details

ID: patch_update_company_details
Operation: write
Entities: company, user, manager
Summary: This API endpoint allows you to update the details of a company associated with the current API key. The request requires headers for authorization, API version, and content type. The body of the request must include the company type, its UUID, and attributes such as the company name. Additionally, you can specify relationships, such as the manager of the company. The response returns the updated company details, including its ID, type, links, attributes like locale and name, and relationships with links to the manager.
Input Fields: Input Fields
Output Fields: Output Fields

Update Custom Field

ID: patch_update_custom_field
Operation: write
Entities: custom field, custom field value, relationship
Summary: The Update Custom Field API allows you to update the details of a custom field in the Teamtailor system. You need to provide the custom field ID in the path parameters and include the updated name in the request body. The request must include headers for authorization, API version, and content type. The response returns the updated custom field details, including its ID, type, links, attributes such as API name, name, field type, creation and update timestamps, and relationships with custom field values.
Input Fields: Input Fields
Output Fields: Output Fields

Update Custom Field Option

ID: patch_update_custom_field_option
Operation: write
Entities: custom field option
Summary: This API endpoint allows you to update a custom field option in the Teamtailor system. The request requires an authorization token and specifies the API version. The request body must include the ID of the custom field option to be updated, the type of the resource, and the new value for the custom field option. The response returns the updated custom field option with its ID, type, links, attributes, and relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Update Custom Field Selects

ID: patch_update_custom_field_selects
Operation: write
Entities: custom field value, custom field option, custom field select
Summary: The 'Update Custom Field Selects' API allows you to update the details of a specific custom field select by its ID. The API endpoint requires a PATCH request to 'https://api.teamtailor.com/v1/custom-field-selects/{id}', where '{id}' is the ID of the custom field select to be updated. The request must include headers for authorization, API version, and content type. The body of the request should contain the updated attributes of the custom field select, such as the name. The response includes the updated details of the custom field select, including its ID, type, attributes like API name, name, field type, and timestamps for creation and last update. It also provides links to related resources and relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Update Custom Field Value

ID: patch_update_custom_field_value
Operation: write
Entities: custom field, custom field value, candidate
Summary: The 'Update Custom Field Value' API allows you to update the value of a custom field for a specific resource in Teamtailor. The API requires a PATCH request to the endpoint 'https://api.teamtailor.com/v1/custom-field-values/{id}', where '{id}' is the ID of the custom field value to be updated. The request must include headers for authorization, API version, and content type. The body of the request should contain the new value for the custom field, along with the relationships to the custom field and owner. The response returns the updated custom field value, including its ID, type, attributes, and relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Update Department

ID: patch_update_department
Operation: write
Entities: role, team, department
Summary: The Update Department API allows you to update the details of a specific department by its ID. The API endpoint is 'https://api.teamtailor.com/v1/departments/{id}' and it uses the PATCH method. You must provide the Authorization token, API version, and content type in the headers. The request body should include the department ID, type, and attributes such as the new name of the department. The response includes the updated department details, including links to related roles and teams, and metadata about the department.
Input Fields: Input Fields
Output Fields: Output Fields

Update Job Details

ID: patch_update_job_details
Operation: write
Entities: location, job, department
Summary: The Update Job Details API allows users to update the details of a specific job by providing the job ID in the path parameters. The request requires authorization and specifies the API version in the headers. The request body includes the job ID, attributes such as title, status, and tags, and the type of resource. The response returns the updated job details, including links to the job on the career site, attributes like status and tags, and relationships with other resources such as activities, department, and role.
Input Fields: Input Fields
Output Fields: Output Fields

Update Note Text

ID: patch_update_note_text
Operation: write
Entities: user, candidate, note
Summary: This API endpoint allows you to update the text of an existing note. You need to provide the note ID in the path parameters and the updated note text in the request body. The request requires authorization and specific headers including 'Authorization', 'X-Api-Version', and 'Content-Type'. The response includes the updated note details such as the note text, creation and update timestamps, and relationships with candidate and user.
Input Fields: Input Fields
Output Fields: Output Fields

Update Notification Setting

ID: patch_update_notification_setting
Operation: write
Entities: notification setting, user
Summary: The Update Notification Setting API allows users to update their notification preferences for email, browser, and mobile notifications. The API requires a PATCH request to the endpoint with the notification setting ID in the path. The request must include headers for authorization, API version, and content type. The body of the request should specify the notification preferences to be updated. The response returns the updated notification setting details, including links to the resource and related user information.
Input Fields: Input Fields
Output Fields: Output Fields

Update Reject Reason

ID: patch_update_reject_reason
Operation: write
Entities: attribute, reject reason, job application
Summary: The Update Reject Reason API allows you to update the details of a specific reject reason by its ID. The API requires the Authorization token, API version, and content type headers. The request body must include the type of resource, the ID of the reject reason, and the attributes to be updated, such as whether the rejection was by the company. The response includes the updated reject reason details, including its ID, type, attributes like reason and rejected-by-company status, and links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Update Requisition

ID: patch_update_requisition
Operation: write
Entities: job, requisition, department
Summary: The Update Requisition API allows users to update the details of an existing requisition in the Teamtailor system. The API endpoint is accessed via a PATCH request to 'https://api.teamtailor.com/v1/requisitions/{id}', where '{id}' is the ID of the requisition to be updated. The request must include headers for authorization, API version, and content type. The body of the request should contain the requisition type, ID, and any attributes to be updated, such as 'job-title' and 'status'. The response includes the updated requisition details, including attributes like 'job-title', 'country', 'currency', and relationships to other resources such as location, department, and recruiter.
Input Fields: Input Fields
Output Fields: Output Fields

Update Requisition Step Verdict

ID: patch_update_requisition_step_verdict
Operation: write
Entities: job, requisition, department
Summary: The Update Requisition Step Verdict API allows users to update the details of a specific requisition by its ID. The API uses the PATCH method and requires an authorization token and API version in the headers. The request body must include the requisition type, ID, and attributes such as job title and status. The response returns the updated requisition details, including job title, country, currency, status, and various relationships like location, department, and role.
Input Fields: Input Fields
Output Fields: Output Fields

Update Team

ID: patch_update_team
Operation: write
Entities: user, team, department
Summary: The Update Team API allows you to modify the details of an existing team in the Teamtailor system. The API requires a PATCH request to the endpoint 'https://api.teamtailor.com/v1/teams/{id}', where '{id}' is the ID of the team you want to update. The request must include headers for authorization, API version, and content type. The body of the request should contain the team ID, type, and attributes such as the team name. The response returns the updated team details, including its attributes and relationships with users, departments, locations, and roles.
Input Fields: Input Fields
Output Fields: Output Fields

Update Todo

ID: patch_update_todo
Operation: write
Entities: assignee, todo, assigner
Summary: The Update Todo API allows you to update the details of a specific todo item by its ID. The API endpoint is 'https://api.teamtailor.com/v1/todos/{id}' and it uses the PATCH method. You must provide the Authorization token, API version, and content type in the headers. The path parameter 'id' is required to specify which todo item to update. The request body should include the 'data' object with 'id', 'attributes' (such as 'due' date), and 'type'. The response includes the updated todo details, including attributes like 'completed-at', 'created-at', 'due', and 'value', as well as relationships to other entities like 'assignee', 'assigner', 'candidate', and 'user'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Candidate

ID: post_create_candidate
Operation: write
Entities: role, candidate, department
Summary: This API endpoint allows you to create a new candidate in the Teamtailor system. To create a candidate, you need to provide the candidate's first name, last name, and optionally a pitch and email. The email is required unless the candidate is sourced. The API requires an authorization token, API version, and content type in the headers. The response includes the candidate's ID, type, attributes such as email, first name, last name, pitch, and various relationships like activities, department, role, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Create Department

ID: post_create_department
Operation: write
Entities: role, team, department
Summary: The Create Department API allows users to create a new department in the system. It requires an Authorization token, API version, and content type headers. The request body must include the department's name under the 'attributes' object. Upon successful creation, the API returns the department's ID, name, and links to related roles and teams. The response also includes metadata about the department resource.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Location

ID: post_create_location
Operation: write
Entities: location, team
Summary: This API endpoint allows the creation of a new location in the Teamtailor system. It requires an Admin scope for authorization. The request must include headers for authorization, API version, and content type. The body of the request should contain the location details such as name, city, country, address, and ZIP code. Upon successful creation, the API returns the details of the newly created location, including its ID, attributes, and relationships with other resources.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Answer

ID: post_create_new_answer
Operation: write
Entities: question, candidate, answer
Summary: This API endpoint allows the creation of a new answer for a candidate to a specific question. The request requires the candidate and question relationships to be specified. If the candidate has already answered the question, the existing answer will be updated. The API does not support creating file or video answers. The request must include headers for authorization, API version, and content type. The body of the request should specify the type of resource, attributes including choices, and relationships for the candidate and question. The response includes the ID, type, links, attributes, and relationships of the created or updated answer.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Candidate Note

ID: post_create_new_candidate_note
Operation: write
Entities: user, candidate, note
Summary: This API endpoint allows the creation of a new note for a candidate in the Teamtailor system. The request requires authentication via a token and specifies the API version and content type in the headers. The body of the request must include the note content, and the IDs of the candidate and user associated with the note. Upon successful creation, the API returns the details of the created note, including its ID, content, timestamps, and relationships to the candidate and user.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Custom Field

ID: post_create_new_custom_field
Operation: write
Entities: custom field, custom field value
Summary: This API endpoint allows you to create a new custom field in the Teamtailor system. The request must include headers for authorization, API version, and content type. The body of the request should specify the type of resource as 'custom-fields' and include attributes such as the name and field type of the custom field. Upon successful creation, the API returns the details of the newly created custom field, including its ID, name, field type, and timestamps for creation and last update. It also provides links to the resource and related custom field values.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Custom Field Select

ID: post_create_new_custom_field_select
Operation: write
Entities: custom field, custom field value, custom field option
Summary: This API endpoint allows you to create a new custom field select in the Teamtailor system. The request requires headers for authorization, API version, and content type. The body of the request must include the type of resource and attributes such as the name of the custom field, its field type, and optional select options. The response includes the ID, type, links, attributes, and relationships of the newly created custom field select.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Custom Field Value

ID: post_create_new_custom_field_value
Operation: write
Entities: custom field, custom field value, candidate
Summary: This API endpoint allows the creation of a new custom field value in the Teamtailor system. The request must include headers for authorization, API version, and content type. The body of the request must contain the 'data' object with 'type', 'attributes', and 'relationships'. The 'value' and 'relationships' fields are required to save a new custom field value. The response returns the created custom field value with its ID, type, attributes, and relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Job Application

ID: post_create_new_job_application
Operation: write
Entities: job application, candidate, job
Summary: This API endpoint allows the creation of a new job application in the Teamtailor system. To create a job application, the API requires the candidate and job relationships to be specified. The request must include headers for authorization, API version, and content type. The request body should contain the type of resource, attributes such as cover letter and sourcing information, and relationships with candidate and job IDs. The response includes the created job application's ID, type, links, attributes like cover letter and timestamps, and relationships with links to candidate, job, stage, and reject reason.
Input Fields: Input Fields
Output Fields: Output Fields

Create a new Region

ID: post_create_new_region
Operation: write
Entities: location, region, meta
Summary: This API endpoint allows the creation of a new region in the system. It requires an authorization token, API version, and content type headers. The request body must include the type of resource and the name of the region to be created. Upon successful creation, the API returns the details of the newly created region, including its ID, name, creation timestamp, and links to related resources. The response also includes metadata about the total number of records and pages.
Input Fields: Input Fields
Output Fields: Output Fields

Create a new Role

ID: post_create_new_role
Operation: write
Entities: role, team, department
Summary: This API endpoint allows the creation of a new role in the system. It requires an Authorization token, API version, and content type headers. The request body must include the type of resource, which should be 'roles', and the attributes containing the name of the role. Upon successful creation, the API returns the details of the newly created role, including its ID, name, and links to related resources such as department and teams.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Stage

ID: post_create_new_stage
Operation: write
Entities: job application, stage, job
Summary: This API endpoint allows the creation of a new stage in the Teamtailor system. The request must include headers for authorization, API version, and content type. The body of the request should specify the type as 'stages', include attributes such as the name of the stage, and define relationships, particularly the job it is associated with. The response returns the details of the newly created stage, including its ID, creation and update timestamps, name, order, and counts of active and rejected job applications. It also provides links to related resources such as job applications, triggers, and the job itself.
Input Fields: Input Fields
Output Fields: Output Fields

Create a new Team

ID: post_create_new_team
Operation: write
Entities: user, team, department
Summary: This API endpoint allows the creation of a new team in the Teamtailor system. The request must include headers for authorization, API version, and content type. The body of the request should specify the team details, including the name and emoji, as well as the user associated with the team. The response returns the details of the created team, including its ID, name, emoji, and various relationship links to users, departments, locations, and roles.
Input Fields: Input Fields
Output Fields: Output Fields

Create a new User

ID: post_create_new_user
Operation: write
Entities: user, job, department
Summary: This API endpoint allows the creation of a new user in the Teamtailor system. It requires a unique email address for the user, and an email invitation will be sent if the role is not 'no-access' or if SSO is activated. The API supports merging user attributes if a user with the same email already exists. The request must include headers for authorization, API version, and content type, and the body must specify user attributes such as title, name, email, role, signature, and merge option. The response includes the user's ID, type, links, attributes, and relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Create Reject Reason

ID: post_create_reject_reason
Operation: write
Entities: job application, reject reason, relationship
Summary: The Create Reject Reason API allows users to create a new reject reason in the system. It requires an authorization token, API version, and content type in the headers. The request body must include the type of resource and attributes such as the reason for rejection and whether it was rejected by the company. The response includes the ID, type, links, attributes, and relationships of the newly created reject reason.
Input Fields: Input Fields
Output Fields: Output Fields

Create Requisition

ID: post_create_requisition
Operation: write
Entities: location, requisition, department
Summary: The Create Requisition API allows users to create a new requisition in the system. It requires an authorization token, API version, and content type in the headers. The request body must include the type of resource, attributes such as country, job title, and status, and relationships including location data. The response returns the created requisition's ID, type, links, attributes like job title, country, and status, and relationships with links to related resources such as location, department, role, recruiter, user, requisition step verdicts, and jobs.
Input Fields: Input Fields
Output Fields: Output Fields

Create a new Team Membership

ID: post_create_team_membership
Operation: write
Entities: user, team, team membership
Summary: This API endpoint allows the creation of a new team membership in the Teamtailor system. To create a team membership, the API requires the relations 'user' and 'team', where a team can be either a job or a team. The request must include headers for authorization, API version, and content type. The body of the request should specify the type of resource and the relationships with the user and team, including their IDs and types. Upon successful creation, the API returns the ID and type of the new team membership, along with links to the resource and its relationships.
Input Fields: Input Fields
Output Fields: Output Fields

Create Todo

ID: post_create_todo
Operation: write
Entities: user, candidate, todo
Summary: The Create Todo API allows users to create a new todo item in the system. The request requires authorization via a token and specifies the API version and content type in the headers. The body of the request includes the type of resource, attributes such as the description of the todo, and relationships to other entities like candidate, user, assigner, and assignee. The response returns the details of the created todo, including its ID, creation time, and links to related entities.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Upload for a Specific Candidate

ID: post_create_upload_for_candidate
Operation: write
Entities: upload, candidate, job
Summary: This API endpoint allows you to create an upload for a specific candidate. It requires a public URL for the file to be uploaded. The request must include headers for authorization and API version, and the body must specify the type of resource, file attributes including the URL and file name, and the candidate relationship with the candidate's ID and type. The response returns the details of the upload, including the upload ID, file URL, file name, and links to related resources such as the candidate and job.
Input Fields: Input Fields
Output Fields: Output Fields

Upload File to Temporary Storage

ID: post_upload_file_to_temporary_storage
Operation: write
Entities: uri, file, resource
Summary: 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. It is useful when public URLs cannot be provided for file retrieval. The transient URI is a unique, tamper-proof token that allows retrieval of the uploaded file from temporary storage and attachment to another resource, such as a Candidate. The URI is exposed only once in the response, so it must be stored until ready for use. If lost, the file must be re-uploaded to obtain a new URI. Files uploaded are not stored permanently and should be used immediately. The endpoint accepts form data requests, not JSON, and the response is always JSON. Required headers include 'Authorization' and 'X-Api-Version'.
Input Fields: Input Fields
Output Fields: Output Fields