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

# Get Frequency Cap

> Get the most marketing emails one contact may receive in a window

Get your company frequency cap: the most marketing emails one contact may
receive in a rolling window, such as 1 email every 16 hours.

Only sequences with `frequencyCapEnabled` respect the cap. When one of their
email steps comes up for a contact who already received the cap's number of
marketing emails in the window, the step is skipped and the contact moves on to
the next step. Campaign emails and marketing sequence emails count toward the
cap, including earlier emails from the same sequence. Campaigns always send.
Transactional emails never count, and transactional steps are never skipped.

Requires the `account:read` scope.

## Request

```bash theme={null}
curl "https://api.sequenzy.com/api/v1/frequency-cap" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Response fields

<ResponseField name="frequencyCap" type="object | null">
  The company cap, or `null` when none is set.
</ResponseField>

<ResponseField name="frequencyCap.maxEmails" type="integer">
  Most marketing emails one contact may receive in the window, from 1 to 50.
</ResponseField>

<ResponseField name="frequencyCap.windowHours" type="integer">
  Rolling window in hours, from 1 to 168.
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "frequencyCap": {
      "maxEmails": 1,
      "windowHours": 16
    }
  }
  ```

  ```json 200 (none set) theme={null}
  {
    "success": true,
    "frequencyCap": null
  }
  ```

  ```json 401 theme={null}
  {
    "error": "Unauthorized"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "API key is missing required scope: account:read"
  }
  ```
</ResponseExample>
