Create an API key
A key lets your own software use the same API the portal uses, within the scopes you pick.
- In the portal, go to Company > API & Webhooks.
- In the API keys card, type a name for what will hold it, for example "Zapier" or "our CRM".
- Tick the scopes it needs. Hover over a scope's help icon to see what it allows.
- Click Create key.
- Copy the key straight away. The portal says "Copy this key now - it is never shown again." Click I saved it when you have.
Your software sends it with every request as a bearer token. The Using the API card on the same page lists what each scope reaches.
Good to know
- A key can't hold powers you don't have yourself.
- Keys can never manage users or roles, or sign porting documents.
- Each key shows when it was last used, or "never used", so you can spot ones nobody needs.
- If you don't see API & Webhooks, ask an administrator.
Was this helpful?
