API Reference
Subscribe to UpdatesHelp CenterComeet

API Permissions

The level of access that an integration has is defined by its permissions.

How permissions work

  1. When you request access to the API, you will be asked to specify the permissions that your integration requires. Please select the minimum set of permissions that that is required to serve the purpose of the integration.
  2. Permissions for the integration are defined by the Recruit representative who creates the secret for your integration.
  3. When an Admin or Owner user activates the integration for their Recruit account:
    1. They are requested to approve the set of permissions that are defined for the integration. They cannot customize this list of permissions.
    2. They can specify which positions will be shared through the integration by selecting one of the following options: All positions, All non-discreet positions, or Only published positions.
  4. Note: the Recruiting API is protected by HTTP CORS header so it cannot be executed from the browser. This is to protect from design mistakes that may reveal the keys or JWT of the API requests.

📘

Changes to permissions

When changes are made to your app's permissions they do not apply to integrations that were already enabled. To apply the updated permissions, an Admin user needs to disable and re-enable the integration by following these steps:

  1. In Recruit, click the avatar menu at the top right > Settings > Integrations.
  2. Find the relevant integration on the page and select Edit.
  3. In the integration window, click Revoke access and confirm.
  4. Re-enable the integration by clicking Integrate > Allow access > Save.

Permissions for the Recruiting API

The following permissions are supported by the Recruiting API:

  1. Locations: Retrieve locations
  2. Positions: Retrieve positions
  3. Positions: Include lead recruiters details in position object
  4. Positions: Include hiring manager details in position object
  5. Positions: Create a new position
  6. Positions: Read position salary range
  7. Positions: Clone a position
  8. Positions: Update a position
  9. Positions: Read position internal name
  10. Openings: Retrieve openings
  11. Openings: Create a new opening
  12. Candidates: Create a new candidate
  13. Candidates: Update candidate's contact details
  14. Candidates: Retrieve candidates created by your app as the source
  15. Candidates: Retrieve candidates created by other sources
  16. Candidates: Include details of step's interviewers / assignees in candidate object
  17. Candidates: Include future workflow steps in candidate object
  18. Candidates: Include source data in candidate object
  19. Candidates: Include source contact ID in candidate object, without personal details
  20. Candidates: Include source contact personal details in candidate object
  21. Candidates: Read candidate salary expectations
  22. Candidates: Read candidate disposition info
  23. Conversations: Create conversations and messages on the candidate profile
  24. Notes: Create notes on the candidate profile
  25. Persons: Delete or Pseudonymize persons
  26. Questionnaires: Read company questionnaires