How do I create an API key with access to confidential data?

Available for User roles Super Admins
Packages Select Lever packages

Confidential hiring in Lever

Confidential Hiring in Lever supports the ability for companies to handle hiring for sensitive roles, such as executives and planned backfills of existing employees. Robust and precise access controls ensure that visibility into these postings, as well as any candidates and requisitions tied to them, can be restricted to a small subset of involved stakeholders. Learn more about confidential job postings and confidential requisitions.


Confidential data in the API:

In Lever you have the option to grant new API keys access to confidential data, including confidential postings, opportunities, and requisitions. If you have built a custom integration and would like it to include confidential data, you will need to ensure that the API key is provisioned with the appropriate access, as well as update your integration to specifically retrieve all data, both non-confidential and confidential.

By default, a list of all requests to the /postings, /opportunities, /candidates, or /requisitions endpoints will exclude confidential data.. This is to help ensure that confidential data is never shared on accident. See additional information on Confidential data in the API here.


Create an API key with access to Confidential data: 

To create a new API key:

1. Go to the API Credentials page in settings. 

2. Click Generate new key in the Lever API credentials section

3. Should you require that the key has access to confidential data, toggle on "Allow access to confidential data" setting prior to saving your API key in a secure location, and clicking "Done".


Note: Once an API keys has been created, its access cannot be edited. A new key must be generated should you require one with updated access.


Was this article helpful?
0 out of 0 found this helpful