There are several use cases with the API that comes in handy, and some examples are:
Add/Import/ candidates and get detailed information about candidates
Export candidates and their information
Build a custom career site
List current job openings, get detailed information, and create new jobs
Automate the User account management process
API keys are used to provide project authorization. These are generated by users with Company Admin level of access to your Teamtailor account by following these steps:
Go to Settings > Integrations > API keys
Click on + NEW API KEY
3. Name the API key to identify the purpose it will be used for and set the scope for the key
Public: Gives access to all information that is visible to the public (on the careersite), such information could for example be a job description.
Internal: Gives access to information that is available in the backend of Teamtailor, such information could for example be candidate data (name, e-mail etc).
Admin: Gives access to all information through the API.
Read: Gives the user of the key the ability to fetch information.
Write: Gives the user of the key the ability to insert data to Teamtailor through the API.
If you have any questions or feedback, please contact us at firstname.lastname@example.org