Developers
Creating an API Key
An API key lets another system, such as your website, a lead source, or your own code, read and update data in one HiringCenter account: prospects, notes, tasks, meetings, and hires, plus the account's stages, users, offices, and sources. You need the Admin or Owner role to create one.
Create the key
- In HiringCenter, open the profile menu → Settings.
- Select the API / Webhooks tab. (If you do not see it, you are not an Admin or Owner on this account.)
- Make sure the account switcher shows the account the key is for. Each key works for one account only; a request that names a different account is refused with
403. - Under API Keys, click Add API Key.
- Enter a Key Name you will recognize later, for example "Website lead form", and an optional Description.
- Choose Access: Read & write (the default) or Read only.
- Click Create Key.
- In IMPORTANT: Save Your API Key, click Copy to Clipboard and save the key in a password manager or secure vault. HiringCenter cannot show it again after you close the window.
Use the key
Send the key in the Authorization header of each request. To check that it works:
Code
A successful response shows the account the key belongs to and that it is active.
The API Quickstart walks through your first requests, and the API Reference lists every endpoint.
Keep it safe
- Never put the key in a public website's front-end code, share it in chat, or commit it to source control.
- If a key may have leaked, open it on API / Webhooks and use Rotate API Key Secret, or mark it inactive and create a new one.
- Mark keys you no longer use inactive. They can be reactivated for 30 days, then they are deleted.
- A key can't create or change other keys. Through the API it can only view, rename, rotate, or delete itself, so automated rotation works, but new keys are always made here.
See API Keys & Webhooks for managing keys and setting up webhooks.
Last modified on

