Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

Every REST API request needs a token. In Breakcold, the token you use for the REST API is called an API key. Use an API key when another app, automation tool, AI tool, or script needs to read or update data in Breakcold.

​
Get your token

  1. Open Breakcold.
  2. Go to Settings.
  3. Open API keys.
  4. Click Create key.
  5. Give the key a clear name, for example “Zapier records sync” or “Reporting dashboard”.
  6. Choose the Scopes. Scopes decide what the key is allowed to do. Start with only the permissions the tool needs, such as Read records.
  7. Choose the Workspace limit. Leave it empty if the key can use every workspace you can access, or select only the workspace the tool should use.
  8. Choose an Expiration. For a short test, choose 30 days. For a trusted automation, choose the duration that matches how your team manages credentials.
  9. Click Create personal key.
  10. Copy the API key immediately.
Breakcold shows the full API key only once. After you close the panel, you can still see the key prefix and activity history, but not the full key again. If you lose it, create a new key and revoke the old one. If you do not see Create key, ask a teammate with the right role to create one for you or update your access.

​
Use your token

When a tool asks for a bearer token, authorization token, or API token, paste your Breakcold API key.

​
Choose your API URL

Use the API URL for the region where your Breakcold workspace is hosted.
Use this URL if your Breakcold workspace is hosted in the United States.
https://http.us.breakcold.com/api/v1
Use the same region in every request. The API Reference pages also let you choose between these two regions in the request playground. When you write an API request yourself, send the key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Example: 
curl "https://http.us.breakcold.com/api/v1/records?workspaceId=YOUR_WORKSPACE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
Replace YOUR_API_KEY with the key you copied from Breakcold. Keep the word Bearer, then add one space, then paste the key.

​
Keep your token safe

An API key can access the data allowed by its scopes and workspace limit. Treat it like a password.
  • Store it in a password manager or in your automation tool’s secure secret field.
  • Do not paste it in public documents, screenshots, chat messages, or support tickets.
  • Give it only the scopes it needs.
  • Revoke it if a tool no longer needs access.
  • Revoke it and create a new one if you think it was shared by mistake.

​
Common errors

401 Unauthorized usually means the token is missing or copied incorrectly. Check that the request includes Authorization: Bearer YOUR_API_KEY. 403 Forbidden usually means the key does not have the right scope or workspace access. Create a new key with the permission the tool needs, then revoke the old one.