​
Authentication

To use Breakcold API, you need to authenticate yourself using your API key. You can find your API key on your Breakcold dashboard here Integrations settings.

Updated API Key Required for Some Endpoints

Please be advised that certain endpoints in the API documentation require the latest version of the API key. The new key version begins with “breakcold-usr”. To obtain the new key, please revoke your previous one.

Failure to update your API key may result in access failure or other issues. Thank you for your cooperation.

​
Header Parameters for Authentication with API Key

x-api-key
string
required

Your Breakcold API key.

{
  "method": "GET",
  "url": "https://api.breakcod.com/rest/lead/123
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_API_KEY_HERE"
  }
}
Get user details