<aside> đĄ This guide will cover how to generate and manage API keys on the API Keys page in admin. Visit the Ashby API Documentation to learn how you can use your API keys.
</aside>
Section Overview:
https://www.loom.com/share/1d65b74344cd455ea4c11ec47752ea61
To create an API key, head to Admin>Integrations>API Keys.
Click â+ Newâ to open the API key setup wizard. Youâll be asked to name your key and have the option to select your Integration Partner.
Next, youâll be asked to select your endpoint permissions. By default, the key will have no permissions.
You can use the checkboxes to allow access to each module and determine whether read or write access should be provided to that module. You can hover over the i icon beside each module to view the endpoints that can be accessed.
You will also have the option to allow access to your confidential jobs.
Once youâve chosen your scopes, click Save and Continue. Youâll then be able to copy your API key on the final step.
<aside> â ď¸ Please note you will not be able to copy your key again after closing out the setup wizard. If you forget or misplace a key, you will need to generate a new one.
</aside>
Once a key is generated, you can click it to review the details including who created it, the date and time it was added, and the last time it was used.
You can click Configure API Key Permissions to adjust access.
To disable a key, click on the key name, then click the Disable button. This can not be undone.
