API keys

Create an API key

1. Open Settings, then APIs.
2. Click New API key.
3. Name the key after what will use it and choose its access: Read and write, or Read only.
4. Click Create key and copy it straight away from Your new API key. It is shown only once.

Copy it once

Right after you create a key, the page shows it in full under Your new API key with a Copy button. Leave the page and it is never shown again: only its first characters stay visible.

Your keys

• Click Keys to open the panel with every key, its access (read and write, read-only or revoked), calls in the last 30 days and when it was last used.
• Click Revoke to stop a key at once. Any request using it is refused.
• A workspace can have up to 10 active keys. Keys are for owners and admins.

Using the API

• Every request needs a key, sent as a bearer token. A request with a missing, wrong or revoked key is refused with 401.
• Read-only keys can fetch data but not change it.
• To add leads to a list, send the ID of the list as list_id: POST /leads with {"email": "jane@acme.com", "list_id": "<list ID>"}. Open the list and click Copy list ID (also on the Lists page).
• Click Read the API docs for every endpoint, with examples for adding leads, creating campaigns and reading stats.