How to Find Your API Key in Breakcold

Breakcold API keys are created in Settings, look like bc_live_…, and are shown once. Two choices you make in the creation panel matter more than the key itself: the scopes you grant, and the workspace limit you set.

Steps to create a Breakcold API key

1. Open Settings In Breakcold, open Settings and find the API keys section. On a US workspace this is at us.breakcold.com/settings — your workspace's region may use a different address, so navigating from inside the app is the reliable route.

2. Create a key Click Create key and give it a name that identifies the tool you are connecting.

3. Grant read and write scopes Scopes decide what the key can do. For a tool that creates and updates contacts, companies, notes and tasks, grant read and write on records, notes, tasks and CRM metadata. A key missing the metadata scope can usually read your data but cannot see your field definitions, which is what most integrations use to map data correctly.

4. Set the workspace limit Use Workspace limit to restrict the key to the single workspace you are connecting. Leaving it empty gives the key access to every workspace you belong to. Many integrations — Add to CRM included — write to exactly one workspace and will refuse a key that reaches several, because there is no safe way to guess which one you meant.

5. Choose an expiry, then copy the key Pick a suitable expiry, then copy the key immediately. Breakcold shows the full key only once; afterwards you can see its prefix and its activity history, but never the full value again. If you lose it, create a new one.

The documentation trap

If you search for Breakcold API documentation, the result that usually ranks first describes a deprecated API on a different host, using a different authentication header. Following it produces authentication errors that look like a bad key.

The current documentation lives at docs.breakcold.com, and current keys authenticate as a bearer token. If the instructions you are reading mention an X-API-Key header, you are on the old docs.

Keeping the key safe

Create one key per integration so you can revoke a single tool's access without disturbing the rest, and delete keys for tools you have stopped using. The activity history on each key is useful here: it shows you what a key has actually been doing before you decide to remove it.

Connecting Breakcold to LinkedIn with Add to CRM

Add to CRM uses your Breakcold key to add contacts from LinkedIn, Gmail and Outlook, with verified email addresses and phone numbers already filled in. Paste the key once on the connect screen — scoped to one workspace, with read and write on records, notes, tasks and metadata — and every profile you open is one click from Breakcold.