{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ea35cd8a-2c6c-425d-bbb3-7db25693ab67","name":"Teamtailor API","description":"The Teamtailor API follows the [JSON API Specification](http://jsonapi.org/).\n\nIf you have any questions or feedback, please contact us at [support@teamtailor.com](https://mailto:support@teamtailor.com)\n\n## Example use cases:\n\n- Add/Import candidates and get detailed information about candidates\n \n- Build a custom career site. Display info about jobs, departments and locations.\n \n- List current job openings, get detailed information and create new jobs\n \n\n### **URLs for EU or NA stack:**\n\nWhen calling Teamtailor’s Public API, the base URL will depend on the stack where your data is being stored.\n\nRequest URLs:\n\n- For EU stack, use [api.teamtailor.com](http://api.teamtailor.com/)\n \n- For NA stack, use [api.na.teamtailor.com](http://api.na.teamtailor.com/)\n \n\n---\n\n# Authentication\n\n``` http\nGET https://api.teamtailor.com/v1/jobs HTTP/1.1\nAuthorization: Token token=abc123abc123\n\n ```\n\nAuthenticate your account when using the API by including your secret API key in the request. [Manage your API keys](https://app.teamtailor.com/app/settings/integrations/api-keys).\n\nAuthentication is performed by passing the api key in the Authorization header.\n\n_You must replace_ `_abc123abc123_` it _with your own API key._\n\n---\n\n## Permissions\n\nYour api keys might have different scopes and permissions.\n\n### Public\n\nHas access to public data, basically all data that is publicly visible on your career site.\n\n#### `read`\n\nCan read all public data, for example, jobs, departments, and locations.\n\n#### `write`\n\nCan create new jobs.\n\n#### `read/write`\n\nCan do all above and update existing jobs.\n\n### Internal\n\nSame as `Public`, but can also access internal, unlisted & archived jobs.\n\n#### `read`\n\nCan read all public & internal data, for example jobs, departments, locations.\n\n#### `write`\n\nCan create new jobs.\n\n#### `read/write`\n\nCan do all above and update existing jobs.\n\n### Admin\n\nHas access to all resources.\n\n#### `read`\n\nCan read all data, for example candidates, jobs, users.\n\n#### `write`\n\nCan create new jobs, candidates and job applications.\n\n#### `read/write`\n\nCan do all above and update jobs, candidates and job applications.\n\n---\n\n# Versioning\n\n``` http\nGET https://api.teamtailor.com/v1/jobs?filter[department]=337 HTTP/1.1\nX-Api-Version : {{api_version}}\n\n ```\n\nWhen we make backwards-incompatible changes to the API, we release new, dated versions. You can use todays date as `X-Api-Version` to always get the latest version of the API.\n\nTo set the API version on a specific request, send a `X-Api-Version` header. See the [API changelog](#changelog) to see current and old versions.\n\n_The_ `X-Api-Version` _header is required when making requests to the API_\n\nSuccessful API requests will have the used API version in the response header `X-Api-Version`\n\n---\n\n# Rate limits & large dataset handling\n\n### **Handling Large Payloads:**\n\nSome endpoints, like `/v1/answers` or `/v1/actions`, may return massive datasets. Attempting to fetch all data in a single request can lead to **HTTP 500 errors**. To avoid this: use filtering, pagination or batch requests.\n\n### Rate Limits:\n\nYou get a bucket of 50 requests every 10 seconds. When the number of requests reaches the rate limit, the api will respond with HTTP status code 429.\n\n> Headers \n \n\n```\nX-Rate-Limit-Limit\n# The number of allowed requests in the current period\nX-Rate-Limit-Remaining\n# The number of remaining requests in the current period\nX-Rate-Limit-Reset\n# The number of seconds left in the current period\n\n ```\n\n---\n\n# Pagination\n\n> Example response \n \n\n``` json\n{\n \"meta\": {\n \"record-count\": 2,\n \"page-count\": 1\n },\n \"links\": {\n \"prev\": \"https://api.teamtailor.com/v1/jobs?filter[department]=337&page[before]=NQ&page[size]=10&sort=id\",\n \"next\": \"https://api.teamtailor.com/v1/jobs?filter[department]=337&page[after]=Ng&page[size]=10&sort=id\",\n }\n}\n\n ```\n\nAll top-level API resources have support for bulk fetches via \"list\" API methods.\n\nThe **links key** in the response may contain any of the following links:\n\n- first: the first page of data\n \n- last: the last page of data\n \n- prev: the previous page of data\n \n- next: the next page of data\n \n\nThe **meta key** contains:\n\n- record-count: The total number of items in the collection,\n \n- page-count: The number of pages\n \n\nThe page size can be changed with the following parameter:\n\n- `page[size]`, the number of resources per page. Default: 10, max: 30.\n \n\n---\n\n# Examples\n\nHere are some real world usage examples of the Teamtailor API.\n\n## Paginate a list\n\nGet the first page of jobs, with 20 jobs per page.\n\n``` http\nGET https://api.teamtailor.com/v1/jobs?page[size]=20 HTTP/1.1\nAuthorization: Token token=abc123abc123\nX-Api-Version: {{api_version}}\n\n ```\n\n### Parameters used in this example\n\n| Parameter | Value | Description |\n| --- | --- | --- |\n| page\\[size\\] | 20 | Get 20 jobs in the list. |\n\n## List published jobs with their department and locations\n\nGet a list of published jobs and include their departments and locations in one request.\n\n``` http\nGET https://api.teamtailor.com/v1/jobs?include=department,locations HTTP/1.1\nAuthorization: Token token=abc123abc123\nX-Api-Version: {{api_version}}\n\n ```\n\n### Parameters used in this example\n\n| Parameter | Value | Description |\n| --- | --- | --- |\n| include | department,locations | Comma separated list of relations to include in the response. |\n\n## List latest hired candidates\n\nGet a list of the most recent hired candidates\n\n``` http\nGET https://api.teamtailor.com/v1/job-applications?include=candidate&filter[stage-type]=hired&sort=-changed_stage_at HTTP/1.1\nAuthorization: Token token=abc123abc123\nX-Api-Version: {{api_version}}\n\n ```\n\n### Parameters used in this example\n\n| Parameter | Value | Description |\n| --- | --- | --- |\n| include | candidate | Since we're fetching latest job applications, we must include the candidate if we wan't more data about each hire. |\n| filter\\[stage-type\\] | hired | Just list job applications marked as hired |\n| sort | \\-changed_stage_at | Sort applications by most recent added to current (hired) stage |\n\n## Create candidate with a To-Many location relationship\n\nCreate a `candidates` resource with a `To-Many` relationship to a `locations` resource set.\n\nThe `location` resource has to be created before this request is executed.\n\n``` http\nPOST https://api.teamtailor.com/v1/candidates HTTP/1.1\nAuthorization: Token token=abc123abc123\nX-Api-Version: {{api_version}}\n{\"data\":{\"type\":\"candidates\",\"attributes\":{\"email\":\"jonas@example.com\",\"pitch\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\"last-name\":\"Jonas\",\"first-name\":\"Brusman\",\"merge\":true},\"relationships\":{\"locations\":{\"data\":[{\"id\":\"1\",\"type\":\"locations\"}]}}}}\n\n ```\n\n---\n\n## Embed application form\n\n### Example iframe\n\n``` html\n\n\n ```\n\n---\n\n### Iframe helper script\n\n``` html\n\n\n ```\n\nTo embed an application form on your website, create an iframe and set the `src` attribute to the job's `careersite-job-apply-iframe-url` attribute. Remember to set `frameborder=\"0\"` and `style=\"width: 100%; height: 800px\"`. To enable features such as auto-resize of the iframe, insert the helper script to the right in the `head` section of your page.\n\n### Create a job from a template\n\nTo create a job from a template you need first to obtain the template ID and then include it in the POST request\n\n``` html\nPOST https://api.teamtailor.com/v1/jobs HTTP/1.1\nAuthorization: Token token=abc123abc123\nContent-Type: application/json\n{\n \"data\":\n {\n \"type\": \"jobs\",\n \"attributes\":\n {\n \"title\": \"Account Manager\",\n \"pitch\": \"Become part of something great!\",\n \"body\": \"

hello

\",\n \"template-id\": 3026014\n },\n \"relationships\":\n {\n \"user\":\n {\n \"data\":\n {\n \"id\": 1479857,\n \"type\": \"users\"\n }\n }\n }\n }\n}\n\n ```\n\nThis will copy everything from the template including triggers, application form, etc. Values used in the payload will overwrite the template, so in above example, body will be set to 'Hello'\n\nYou can fetch list of templates using GET jobs?filter\\[status\\]=template\n\nIf you need to fetch a specific template, you can add `&filter[template-name]=template_name` to the existing filter in the request. For example: `GET jobs?filter[status]=template&filter[template-name]=your_template_name`\n\n# Changelog\n\n#### 2026-02-11\n\n- Added information about required attributes/relationships to [Jobs](https://docs.teamtailor.com/#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n- Added information about required attributes/relationships to [Requisitions](https://docs.teamtailor.com/#3a64e9b5-c1d4-4894-8978-2015adf13ec2).\n \n- Added information about required attributes/relationships to [Job Applications](https://docs.teamtailor.com/#3a64e9b5-c1d4-4894-8978-2015adf13ec2).\n \n- Added information about required attributes/relationships to [Candidates](https://docs.teamtailor.com/#2f779ec9-9bc7-44d6-ac38-a5ef5c81396d).\n\n- Added information about required attributes/relationships to [Uploads](https://docs.teamtailor.com/#398f4f78-12da-411b-8379-f5523366ac4d).\n \n\n#### 2026-02-04\n\n- Added `linkedin-url` to [Referral](https://docs.teamtailor.com/#d5845719-6ff8-4ea4-a765-a2864b02be9f).\n \n- Added the `division` relation to [Referral](https://docs.teamtailor.com/#d5845719-6ff8-4ea4-a765-a2864b02be9f).\n \n\n#### **2025-12-17**\n\n- Added the `resume-updated-at` to [Candidate](https://docs.teamtailor.com/#1e591a5a-99cc-4d17-aaeb-7744dde0dbb2).\n \n\n#### 2025-11-25\n\n- Added [Interviews](https://docs.teamtailor.com/#fb801ae1-f1cd-4edb-8116-74afab2d3c3d), [Scorecard Criteria](https://docs.teamtailor.com/#0e586bbd-ba57-4c86-b40e-63f56dadd143), [Scorecard Picks](https://docs.teamtailor.com/#28d0b5c3-4420-4c22-9436-7384ba99ab47), [Scorecard Scores](https://docs.teamtailor.com/#1283166e-1681-40e2-b4ca-12397e1a86db) resources.\n \n- Added the `interviews` relations to [Candidate](https://null),\n \n\n#### 2025-10-30\n\n- Added `upload` relation to [Answer](https://docs.teamtailor.com/#bc7522c7-6c6f-4e49-b8e9-737669b4fd8f).\n \n- Added `answer` relation to [Upload](https://docs.teamtailor.com/#398f4f78-12da-411b-8379-f5523366ac4d).\n \n\n#### 2025-10-03\n\n- Updated `POST /v1/requisitions` endpoint with automatic approval flow\n \n\n#### 2025-10-02\n\n- Added a note in **Rate Limits** documentation about handling large datasets.\n \n\n#### 2025-10-01\n\n- Updated API version header requirement\n \n- All requests must now include: X-Api-Version: 20240904\n \n\n#### 2025-09-09\n\n- Added `resume-summary` to [Candidate](https://docs.teamtailor.com/#2f779ec9-9bc7-44d6-ac38-a5ef5c81396d)\n \n\n#### 2025-07-15\n\n- Added `is-draft` to [Requisitions](https://docs.teamtailor.com/#1e928d4e-a299-4211-902e-ff2472ec4bb1)\n \n\n#### 2025-07-09\n\n- Added [Divisions](https://docs.teamtailor.com/#5c46f829-f1cb-446c-ae59-bdfcb40f1672) resources.\n \n- Added the `divisions` relations to [Candidate](https://docs.teamtailor.com/#2f779ec9-9bc7-44d6-ac38-a5ef5c81396d), [Jobs](https://docs.teamtailor.com/#afd29ca3-689f-49a2-ba5d-d67f4ac4f757) and [Departments](https://docs.teamtailor.com/#97830188-a759-44ad-89d4-6d9ee64bad8a).\n \n- Added filter by `division` in the [Jobs list](https://docs.teamtailor.com/#a0351972-8394-4646-95f0-56a4c4e3886d) and in the [Candidates list](https://docs.teamtailor.com/#759f6a0c-5b05-4d9c-b1c8-af80c5d9b620).\n \n\n#### 2025-04-03\n\n- Added [Forms](https://docs.teamtailor.com/#62df92b7-3b98-447e-aba2-88ea51857872), [Form questions](https://docs.teamtailor.com/#4e8d9aaf-951e-41aa-af03-a30979fdf08c) and [Form answers](https://docs.teamtailor.com/#c4778d98-6661-4231-b857-672794fc1241) resources.\n \n- Added the [Onboardings](https://docs.teamtailor.com/#e207bdd5-8fd2-40a5-ac40-2abb20857310) resource, available for customers using the [Onboarding add-on feature](https://support.teamtailor.com/en/articles/10264836-start-the-onboarding-of-your-new-hires-in-teamtailor).\n \n- Added Onboardings and Form answers relationships to [Candidates](https://docs.teamtailor.com/#2f779ec9-9bc7-44d6-ac38-a5ef5c81396d).\n \n\n#### 2024-11-12\n\n- Added `/authenticated-video-url` endpoint to [answers](https://docs.teamtailor.com/#bc7522c7-6c6f-4e49-b8e9-737669b4fd8f) to get the playable video URL for video answers. The URL is valid for 2 hours.\n \n\n#### 2024-09-30\n\n- Added `jobs` relation to [teams](https://docs.teamtailor.com/#d6c677e8-7105-4bbf-9413-4be624294a6e).\n \n- Added `team-memberships` relation to [users](https://docs.teamtailor.com/#a594cdda-efeb-4b67-b2a2-1b72baecd786).\n \n\n#### 2024-09-05\n\n- New Api version available `X-Api-Version: 20240904`.\n \n- BREAKING CHANGES: Notes listing now follows the JSON api data strucutre. Instead of the data being wrapped inside \"notes\" it's now in \"data\", as all our listings. It also allows paginating.\n \n\n#### 2024-07-02\n\n- added `template-id` to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2024-05-29\n\n- Added `job` and `stage-type` filters to [stages](#f7d1f021-112b-4631-9283-906429f805b5).\n \n\n#### 2024-05-24\n\n- Added match score to [job-applications](#3a64e9b5-c1d4-4894-8978-2015adf13ec2) (read-only).\n \n\n#### 2024-04-10\n\n- Added new [nps-responses](#55639fbf-f69a-4981-b775-05522a00f5fb) resource (read-only).\n \n\n#### 2024-04-04\n\n- New Api version available `X-Api-Version: 20240404`.\n \n- BREAKING CHANGES: The old `stage-type` attribute of [stages](#f7d1f021-112b-4631-9283-906429f805b5) is renamed to `legacy-stage-type-name` to facilitate a new relationship for `stage-types`. This is not backwards compatible.\n \n- New resource [stage-types](#04411254-2faa-4e70-9721-5e7a98db2f94) can be used to list all stages/job-applications/candidates for a type of stage.\n \n- Added `stage-type` as relationship to [stages](#f7d1f021-112b-4631-9283-906429f805b5).\n \n\n#### 2023-08-24\n\n- Added `consent-future-jobs-at` and `consent-given-future-jobs` to [candidates](#2f779ec9-9bc7-44d6-ac38-a5ef5c81396d)\n \n\n#### 2021-08-06\n\n- Add `tags` filter to [job](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757)\n \n- Add `custom-fields` filter to [custom-field-options](#custom-field-options)\n \n- Add `custom-fields` relationship to [job](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757)\n \n\n#### 2021-05-05\n\n- Added `updated-at` attribute to [job](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757)\n \n\n#### 2021-02-18\n\n- New Api version available `X-Api-Version: 20210218`.\n \n- BREAKING CHANGES: Changes related to user and notification settings api are no longer compatible with `X-Api-Version: 20161108`.\n \n- Added changes to [users](#users) resource.\n \n- Added new [notification-settings](#notification-settings) resource.\n \n\n#### 2020-11-30\n\n- Added read-only `original-resume` field to [candidates](#candidates) to get the original file before converted to PDF.\n \n\n#### 2020-10-29\n\n- Updated documentation for [Custom Fields](#custom-fields).\n \n- Added new [custom-field-selects](#custom-field-selects) resource.\n \n- Added new [custom-field-options](#custom-field-options) resource.\n \n\n#### 2020-10-06\n\n- Added `remote-status` attribute to [job](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2020-10-01 _Bug fix_\n\n- Removed the [activities](#activities) list endpoint (since it didn't work anyway).\n \n- Added `activities` relationships to the [users](#users), [candidates](#candidates), and [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757) resources.\n \n- To list activities, please use any of these relationships.\n \n\n#### 2020-07-20\n\n- Added new [notes](#notes) resource.\n \n- Added new [regions](#regions) resource.\n \n- Added `regions` relationship and filter to [candidate](#candidates) and [job](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2020-05-14\n\n- Added `job` relationship and filter to [upload](#uploads).\n \n\n#### 2020-05-13\n\n- Added `external-id` attribute to [user](#users).\n \n\n#### 2020-05-12\n\n- Added new [team](#teams) resource.\n \n- Added `update`, `create`, and `delete` actions to the [role](#roles) resource.\n \n- Added `teams` relationship to [department](#departments) __and [role](#roles).\n \n\n#### 2020-04-23\n\n- Added `job` relationship to [partner-result](#partner-results).\n \n- Added `partner-results` relationship to [candidate](#candidates).\n \n\n#### 2020-02-26\n\n- Added `api-name` field to [custom-field](#custom-fields).\n \n\n#### 2019-11-14\n\n- Added `signature` field to [user](#users).\n \n\n#### 2019-11-14\n\n- Added the [requisitions](#requisitions) resource.\n \n- Added the [requisition-step-verdicts](#requisition-step-verdicts) resource.\n \n\n#### 2019-09-10\n\n- Added the [custom-fields](#custom-fields) resource.\n \n- Added the [custom-field-values](#custom-field-values) resource.\n \n\n#### 2019-08-09\n\n- Added the [referrals](#referrals) resource.\n \n\n#### 2019-08-08\n\n- Added the [partner-results](#partner-results) resource.\n \n\n#### 2019-08-07\n\n- Added the [activities](#activities) resource.\n \n\n#### 2019-07-31\n\n- Added the [todos](#todos) resource.\n \n\n#### 2019-07-15\n\n- Added `row-order` field to [stages](#stages).\n \n\n#### 2019-07-11\n\n- Added `mailbox` field to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2019-07-03\n\n- Added `referred` field to [candidates](#candidates).\n \n\n#### 2019-06-18\n\n- Added `login-email` field to [users](#users).\n \n\n#### 2019-05-17\n\n- Added `locations` _resource to_ [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757)_._ `_location_` _resource is now deprecated and will be removed after 2019.08.01_.\n \n\n#### 2019-05-06\n\n- Added the [trigger](#triggers) resource.\n \n\n#### 2019-04-23\n\n- Added `show` and `list` actions to the [stages](#stages) resource.\n \n- Added `active-job-applications-count` and `rejected-job-applications-count` attributes to [stages](#stages).\n \n\n#### 2019-04-23\n\n- Added the [company](#companies) resource.\n \n\n#### 2019-04-15\n\n- Added `pitch` attribute to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2019-03-07\n\n- Added `scheduled` status filter to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757) for internal/admin keys.\n \n\n#### 2019-03-07\n\n- Added `jobs` relation to [users](#users) (the jobs user is recruiter for).\n \n\n#### 2019-01-09\n\n- Added `set-consent-expiration` to [candidates](#candidates) to set consent expiration period for candidates who gave their permission for you to store their personal details.\n \n\n#### 2018-11-05\n\n- Signed URLs to [Uploads](#uploads) files are valid for 1 minute.\n \n\n#### 2018-09-17\n\n- Filter [Jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757) by status `archived`.\n \n\n#### 2018-07-17\n\n- Added `created-at` field to `jobs`\n \n\n#### 2018-05-31\n\n- Added `send-default-reply` attribute to [job-applications](#job-applications)\n \n\n#### 2018-05-11\n\n- [Picked questions](#picked-questions) _endpoint._\n \n- Added `picked-questions` resource to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757)\n \n- Added `name_requirement`, `resume_requirement`, `cover_letter_requirement`, `phone_requirement` attributes to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757)\n \n\n#### 2018-05-22\n\n- New [User](#users) attributes for GDPR/data retention notifications. (`notification-removal-request` and `notification-gdpr-digest`)\n \n\n#### 2018-04-26\n\n- [List questions](#list-questions) _endpoint._\n \n\n#### 2018-04-19\n\n- Add user notification settings attributes to the user object.\n \n- Add TeamMembership object to enable index, view, create and destroy actions on hiring team members.\n \n\n#### 2018-04-05\n\n- Add `colleagues` relation to `jobs` (lists `users` related to the job ad).\n \n\n#### 2018-04-04\n\n- Add `external-application-url` field to `jobs`.\n \n\n#### 2018-03-02\n\n- Filter [candidates](#candidates) by `locations`.\n \n\n#### 2018-02-13\n\n- New resource [Uploads](#uploads).\n \n- Added `uploads` resource to [candidates](#candidates).\n \n- Filter [candidates](#candidates) by `connected`, `department` and `role`.\n \n\n#### 2018-01-25\n\n- Added `locations` resource to [candidates](#candidates).\n \n- Filter [users](#users) by `email`.\n \n- Can update `email` attribute on [users](#users).\n \n\n#### 2018-01-16\n\n- Added `create` and `update` actions to [users](#users).\n \n\n#### 2017-10-31\n\n- Added `tags` to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2017-09-06\n\n- Added `apply-button-text` attribute to [jobs](#afd29ca3-689f-49a2-ba5d-d67f4ac4f757).\n \n\n#### 2017-03-15\n\n- Added `single-line` attribute to [questions](#questions).\n \n\n#### 2017-03-10\n\n- Added `changed_stage_at` to [job applications](#job-applications).\n \n- Made it possible to filter on `stage-type` when listing [job applications](#job-applications).\n \n\n#### 2017-02-23\n\n- New resources\n \n - [Answers](#answers)\n \n - [Candidates](#candidates)\n \n - [Job Applications](#job-applications)\n \n - [Questions](#questions)\n \n - [Stages](#stages)_._____\n \n- New scopes [Admin](#authentication) and [Internal](#authentication).\n \n- [Embed job appliction form as an iframe](#embed-application-form)_._\n \n\n#### 2016-11-08 New version\n\n- _First public version._","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14157246","team":1502963,"collectionId":"ea35cd8a-2c6c-425d-bbb3-7db25693ab67","publishedId":"TVzSiGxA","public":true,"publicUrl":"https://docs.teamtailor.com","privateUrl":"https://go.postman.co/documentation/14157246-ea35cd8a-2c6c-425d-bbb3-7db25693ab67","customColor":{"top-bar":"34353A","right-sidebar":"28282B","highlight":"F43F85"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-02-01T09:34:24.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Teamtailor","id":"0a1d21ed-80bf-49dc-afe7-a54fc680be99","owner":"14157246","values":[{"key":"api_url","value":"api.teamtailor.com","enabled":true},{"key":"api_version","value":"20240404","enabled":true},{"key":"companyGetSchema","value":"{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"_id\":{\"type\":\"string\"},\"shareable\":{\"type\":\"object\",\"properties\":{\"team\":{\"type\":\"object\",\"properties\":{\"fields\":{\"type\":\"array\",\"items\":{}}},\"required\":[\"fields\"]},\"enabled\":{\"type\":\"boolean\"},\"euIds\":{\"type\":\"array\",\"items\":{}},\"sunits\":{\"type\":\"boolean\"}},\"required\":[\"team\",\"enabled\",\"euIds\",\"sunits\"]},\"followers\":{\"type\":\"array\",\"items\":{}},\"domains\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"},{\"type\":\"string\"}]},\"collaborators\":{\"type\":\"array\",\"items\":{}},\"products\":{\"type\":\"array\",\"items\":{}},\"tags\":{\"type\":\"array\",\"items\":{}},\"lastPerformedTriggers\":{\"type\":\"array\",\"items\":{}},\"status\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"slug\":{\"type\":\"string\"},\"externalId\":{\"type\":\"string\"},\"phase\":{\"type\":\"string\"},\"sourceId\":{\"type\":\"string\"},\"h\":{\"type\":\"integer\"},\"csmScore\":{\"type\":\"integer\"},\"mr\":{\"type\":\"integer\"},\"nrr30\":{\"type\":\"integer\"},\"custom\":{\"type\":\"object\",\"properties\":{\"Paid invoice?\":{\"type\":\"boolean\"},\"Team Members\":{\"type\":\"string\"},\"Objective 1\":{\"type\":\"null\"},\"Industry\":{\"type\":\"string\"},\"Hours Completed\":{\"type\":\"integer\"}},\"required\":[\"Paid invoice?\",\"Team Members\",\"Objective 1\",\"Industry\",\"Hours Completed\"]},\"mrrTotal\":{\"type\":\"integer\"},\"nrrTotal\":{\"type\":\"integer\"},\"mrTotal\":{\"type\":\"integer\"},\"nextTouch\":{\"type\":\"integer\"},\"country\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"csmScoreLog\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{\"date\":{\"type\":\"string\"},\"score\":{\"type\":\"integer\"}},\"required\":[\"date\",\"score\"]}]},\"phaseSince\":{\"type\":\"string\"},\"createDate\":{\"type\":\"string\"},\"lastUpdated\":{\"type\":\"string\"},\"lastTouchByType\":{\"type\":\"object\"},\"sales\":{\"type\":\"array\",\"items\":{}},\"licenses\":{\"type\":\"array\",\"items\":{}},\"features\":{\"type\":\"object\"},\"sunits\":{\"type\":\"object\"},\"usage\":{\"type\":\"object\"},\"documents\":{\"type\":\"array\",\"items\":{}},\"links\":{\"type\":\"array\",\"items\":{}},\"alerts\":{\"type\":\"array\",\"items\":{}},\"lastActivities\":{\"type\":\"array\",\"items\":{}},\"updatedAt\":{\"type\":\"string\"},\"__v\":{\"type\":\"integer\"},\"orgPathCount\":{\"type\":\"integer\"}},\"required\":[\"_id\",\"shareable\",\"followers\",\"domains\",\"collaborators\",\"products\",\"tags\",\"lastPerformedTriggers\",\"status\",\"name\",\"slug\",\"externalId\",\"phase\",\"sourceId\",\"h\",\"csmScore\",\"mr\",\"nrr30\",\"custom\",\"mrrTotal\",\"nrrTotal\",\"mrTotal\",\"nextTouch\",\"country\",\"description\",\"csmScoreLog\",\"phaseSince\",\"createDate\",\"lastUpdated\",\"lastTouchByType\",\"sales\",\"licenses\",\"features\",\"sunits\",\"usage\",\"documents\",\"links\",\"alerts\",\"lastActivities\",\"updatedAt\",\"__v\",\"orgPathCount\"]}","enabled":true},{"key":"api_key","value":"od71S1zmxWetVvzz6ovSeznEPb-OdsZZSX9EeBi9","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0a4a537689c6c48839e22b6285bfaaf98b70b99085b7596f59d93cce315862ec","favicon":"https://res.cloudinary.com/postman/image/upload/v1610442763/team/oal3holec8tcwcdl9eyl.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Teamtailor","value":"14157246-0a1d21ed-80bf-49dc-afe7-a54fc680be99"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVzSiGxA"}