--- title: How do I generate an API key? slug: how-do-i-generate-an-api-key docTags: HnLaVwOXkGQqP1zfLQjeE,rl7p3XLQknqPB1UQ70cu_ createdAt: 2025-07-10T11:56:44.877Z --- This guide covers how to generate and manage Application Programming Interface (API) keys on the **[API Credentials](https://app.ashbyhq.com/admin/api/credentials)** page in **Admin**. :::hint{type="info"} For further information on the API, check out [Ashby's API documentation](https://developers.ashbyhq.com/). ::: # Permissions & access API Keys are available on the Foundations, Legacy Plus, Plus, and Enterprise plans. | Foundations | Legacy Plus | Plus | Enterprise | | ----------- | ----------- | ---- | ---------- | | ✅ | ✅ | ✅ | ✅ | :::hint{type="warning"} You must be an Organization Admin to generate API keys in Ashby. ::: # Video overview This video overview is optional - see below for step-by-step written instructions. ::loom{url="https://www.loom.com/embed/1d65b74344cd455ea4c11ec47752ea61"} # Create a new API key 1. Navigate to **Admin > Integrations >** **[API Credentials](https://app.ashbyhq.com/admin/api/credentials)**. 2. Click `+ New` to open the API key setup wizard. 3. Name the key, specify a version, and, optionally, select an Integration Partner. 4. Click `Create API Key` to continue. ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/3BK2E_Yy5zHBh_YSZr4vv_api-credentials-ashby-2026-09-22-at-11100-pm.jpg" size="90" isUploading="false" width="785" height="455" darkWidth="785" darkHeight="455" alt="Create an API Credential dialog in Ashby with fields to name the API key and optionally select an integration partner, followed by steps for API Scopes and Credentials." showCaption="false"} 5. Select the endpoint permissions. By default, the key has no permissions. ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/7PdNXtZ8teeMWxGEvQBlC_api-credentials-ashby-2026-09-22-at-11332-pm.jpg" size="80" isUploading="false" width="784" height="877" darkWidth="784" darkHeight="877" alt="Create an API Credential dialog on the API Scopes step, showing endpoint permission modules with Read and Write checkboxes and options to select all permissions." showCaption="false"} :::Paragraph{indent="1"} Use the checkboxes to allow access to each module and determine whether to grant read or write access to that module. ::: ::::hint{type="info"} :::Paragraph{indent="1"} Hover over each module to view the endpoints it can access. ::: :::: 6. Scroll down to **Other Permissions** and determine whether to grant any additional permissions, including: - Allowing access to confidential jobs and projects - Allowing access to non-offer private fields - Allowing updates to application history - Allowing access to quality of hire data - Allowing access to Hiring Manager Experience survey data - Allowing on-behalf-of requests (enabling the API key to perform actions as a specific user) ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/pOxS0FDL8NhI1M9MasAwO_api-credentials-ashby-2026-09-22-at-11530-pm.jpg" size="80" isUploading="false" width="766" height="865" darkWidth="766" darkHeight="865" alt="Create an API Credential dialog on the API Scopes step, showing additional permissions for accessing confidential jobs, private fields, application history, quality of hire data, Hiring Manager Experience survey data, and on-behalf-of requests." showCaption="false"} 7. After choosing your scopes, click `Save and Continue`, then copy your API key on the final step. :::hint{type="danger"} You will not be able to access your API key after closing the setup wizard, so ensure it is copied and/or kept in a safe place. ::: # View API key details After you generate a key, click it to review its details, including who created it, the date and time it was added, and the last time it was used. You can edit the API key's permissions and scope if needed. Click `Save` to apply your changes. ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/0PE6oyLYrF_HXSBThgYnV_editing-an-api-key.jpg" size="70" isUploading="false" width="1154" height="1618" darkWidth="1154" darkHeight="1618" showCaption="false" alt="API key settings showing an active key with default source options and endpoint permissions, with Read access enabled for Candidates and Interviews."} ## API key versioning When viewing your API key, you will also see the version the API key was created with. Our [API documentation](https://developers.ashbyhq.com/reference/introduction) includes versioning for your reference. ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/NpWNP-pw-ywh6ettYupzo_api-key-with-version.jpg" size="80" isUploading="false" width="1182" height="1358" darkWidth="1182" darkHeight="1358" alt="An API key with an active API version." showCaption="false"} If a version is not supported or has been retired, a warning will be shown within the API key's details. ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/DpqNHj42DV29XLq_hleFA_api-key-on-a-depreciated-version.jpg" size="80" isUploading="false" width="1312" height="1200" darkWidth="1312" darkHeight="1200" alt="An API key with a retired API version." showCaption="false"} The version and an indicator will also be displayed in your API key list at **Admin > Integrations > API Keys**. An indicator will show beside the version: - If the indicator is green, the API version is still active. - If the indicator is orange, the API version is deprecated and a new API key should be generated to avoid disruption. - If the indicator is red, the API version is unsupported and a new API key should be generated to avoid disruption. ![Active key list including the status, version and integration partner.](https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/ju3t0EKCQwfrAm6kqc_Et_add-api-key-version-selection-equest-107908-ashbyhqashby-2026-09-10-at-93158-am.jpg) :::hint{type="warning"} If a version is ever retired, you will be given at least 6 months notice. ::: # Disable an API key To disable a key, click the key name to open the API key details, then click `Disable`. ::Image[]{src="https://api.archbee.com/api/optimize/0p8tQ--ZZOxRtkVp6Qr-e/VyCAvirXXrnvYXWwPP5da_deleting-an-api-key.jpg" size="70" isUploading="false" width="1154" height="1618" darkWidth="1154" darkHeight="1618" showCaption="false" alt="API key settings showing an active key with the Disable button highlighted in the upper-right corner."} # FAQs ### Can I copy a key again after closing the setup wizard? You cannot view or copy keys after closing the setup wizard, so be sure to copy the key before closing. We remind you before you close a window if the key is not on your clipboard. ### What is the API rate limit? The API rate limit is 1000 requests per minute per API key.