> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/campaigns/openapi.json](/docs/api/campaigns/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Campaigns: Count contacts by gateway and mailbox host

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

One endpoint of [Campaigns](/docs/api/campaigns.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Count contacts by gateway and mailbox host

`GET /v1/campaigns/{campaignId}/mail-providers` - operationId `campaigns.get-mail-providers`

| Permission | Rate limit |
| --- | --- |
| Campaigns view | 12,000 requests a minute per API key |

Counts the campaign's contacts by the email security gateway in front of their address and by the host of their
mailbox. Each contact is judged by its first Safe or Verified email, the one the contact list shows.

`gateways` lists every security gateway and `mailboxProviders` every mailbox host and forwarding
service Kenso tracks, including those with 0 contacts, most contacts first. `pendingCount` counts contacts
whose domain is not checked for a gateway yet. At most 100,000 contacts are counted; past that,
`isPartial` is true.

Errors:

- `404 not_found`: the campaign does not exist in this workspace.

Requires Campaigns view.

Needs the `security_gateways` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/campaigns/GET/v1/campaigns/%7BcampaignId%7D/mail-providers)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campaignId` | path | integer (int64) | yes | Id of the campaign. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `CampaignMailProviders`.

| Field | Type | Description |
| --- | --- | --- |
| `gateways` | array of MailProviderCount | Every security gateway Kenso tracks, including those with 0 contacts, most contacts first. |
| `mailboxProviders` | array of MailProviderCount | Every mailbox host and forwarding service Kenso tracks, including those with 0 contacts, most contacts first. |
| `pendingCount` | integer (int32) | Contacts whose email domain is not checked for a gateway yet. |
| `isPartial` | boolean | True when the campaign has more than 100,000 contacts, so only the first 100,000 are counted and the counts are a minimum. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/campaigns/812/mail-providers" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "gateways": [
      {
        "slug": "proofpoint",
        "name": "Proofpoint",
        "count": 212
      },
      {
        "slug": "mimecast",
        "name": "Mimecast",
        "count": 87
      }
    ],
    "mailboxProviders": [
      {
        "slug": "google_workspace",
        "name": "Google Workspace",
        "count": 1104
      },
      {
        "slug": "microsoft_365",
        "name": "Microsoft 365",
        "count": 736
      }
    ],
    "pendingCount": 64,
    "isPartial": false
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### MailProviderCount

Contacts behind one security gateway or mailbox host.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `slug` | string | no | Short id of the gateway or host, such as `proofpoint` or `google_workspace`. |
| `name` | string | no | Display name of the gateway or host. |
| `count` | integer (int32) | no | Number of contacts behind it. |
