> ## Documentation Index
> Fetch the complete documentation index at: https://developer.breakcold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start requesting Breakcold API in a few steps.

## 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](https://app.breakcold.com/settings/integrations).

<Warning>
  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.
</Warning>

### Header Parameters for Authentication with API Key

<ParamField header="x-api-key" required type="string">
  Your Breakcold API key.
</ParamField>

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

## Endpoint

The endpoint for Breakcold API is `https://api.breakcold.com/rest`.

## Rate Limiting

To ensure stability and fair use for everyone, our API enforces rate limits per user.

**Current rule:**

* You can send up to **60 requests per 60-seconds window**.

If you exceed this limit, the API will return a **`429 Too Many Requests`** error until your quota resets.

**How to check your current usage**
Each API response includes rate-limit information in the headers:

| Header                  | Description                                                  |
| ----------------------- | ------------------------------------------------------------ |
| `X-RateLimit-Limit`     | The maximum number of requests allowed per window (e.g. 60). |
| `X-RateLimit-Remaining` | How many requests you have left in the current window.       |
| `X-RateLimit-Reset`     | Time (in seconds) until the limit resets.                    |

By checking these headers, you can monitor your usage and avoid hitting the limit.

**Example**

```http theme={null}
HTTP/1.1 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 12
X-RateLimit-Reset: 145
```

In this example:

* You’ve made 48 requests so far (60 - 12 = 48).
* Your limit will reset in 145 seconds.

## Support

If you encounter any issues while using Breakcold API, please contact our support team at [support@breakcold.com](mailto:support@breakcold.com).

Thank you for choosing Breakcold! We hope that our API will help you achieve your goals.

## Next Steps

Here are some next steps to help you get started with Breakcold API:

<CardGroup>
  <Card title="API reference" icon="square-code" iconType="duotone" href="/v3/api-reference/introduction">
    Our API reference provides  information about our endpoints.
  </Card>

  <Card title="API key" icon="key" href="https://app.breakcold.com/settings/integrations">
    Get my api key
  </Card>
</CardGroup>