Your API keys

Making a key

1. Open your avatar › API keys and choose New API key.
2. Name it after what will use it, for example your reporting tool.
3. Choose Read only or Read and change.
4. Copy it now: the key is shown only once.

What a key may do

A key does what you may do in this workspace and no more: an Owner's key sees everything, a partner manager's key sees their own partners, a partner's key sees only that partner's own numbers. It never does what only a person signed in may do, such as managing keys, passwords or the team.

Every change made with a key is named after it in the activity log, for example "API key «BI» (made by Maria)", so you always know what came through the API.

Using it

Send it with every call to your workspace's address, in x-api-key or as Authorization: Bearer. The calls are listed in The API reference.

Good to know

• Your workspace's HitCTRL plan decides whether keys work and how many calls a minute they may make. Over the limit, the answer is 429 with Retry-After.
• Revoke a key you no longer use: it stops at once and stays listed, so its changes keep its name.
• Tracking calls from your server use the workspace's own keys: see API keys.