Skip to main content

FAQ - API

Updated over a week ago

How can I get an API token?

To obtain the API token in Recruitee, go to Settings > Apps and plugins > Personal API tokens.

Click the + New token button in the top-right corner to generate your personal API token.

💡 Keep in mind that the permissions associated with this API token are be based on the Hiring role of the person who created it. The token does not expire unless it is manually revoked by the user.


Where can I find the company, offer, and candidate IDs needed for an API call?

You can find the required IDs in the following places:

Company ID

Offer ID (Job ID)

  • Go to the Jobs tab

  • Click Edit next to the job

  • The offer ID can be found in the URL, after job-editor:

Note: The ID that starts with # and contains both letters and numbers can't be used for API purposes.


Candidate ID

  • Open the candidate’s profile in Recruitee

  • The candidate ID can be found in the URL, after candidate=


How can I get the company's XML feed?

To access your company's job feed, you can choose from the following options:

Formatted XML feed

Use this URL to get the formatted XML data: https://{yourcompany}.recruitee.com/api/feeds/offers.xml

Raw XML feed

If you prefer the raw XML data, use: https://{yourcompany}.recruitee.com/api/offers.xml

JSON feed

For JSON data, use:

https://{yourcompany}.recruitee.com/api/offers

Replace {yourcompany} in the URL with the subdomain of your company's careers site. You can find your subdomain in Settings > Company settings > Careers site

The provided XML feeds are not customizable. However, you can generate your own XML feed using the API. For more information, please refer to the documentation 📖


Can I transfer data between different Recruitee accounts?


It is possible to export or transfer data using the API, but direct transfer between accounts can be difficult.

Consider using tags (job tags) or departments to differentiate which departments belong to which company.

📌 Job boards pull jobs from your account based on the company name, so you may need to contact the support of the job board in question to display jobs with a specific tag on the correct page.


Is it possible to give permissions to manage Personal API Tokens to a Reviewer?


You can enable the creation and editing of personal API tokens for a team member within the account by following these steps.

1. Click on Settings

2. Go to Company > Hiring roles

3. Go to the Add-on tab and tick the box for Manage API tokens


Did this answer your question?