---
title: "List sending domains and their Inbox Insights status"
method: GET
path: "/v1/email/inbox-insights/domains"
tags: ["email-inbox-insights"]
---

# List sending domains and their Inbox Insights status

`GET /v1/email/inbox-insights/domains`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/inbox-insights/domains`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns a page of sending domains this workspace can report on, in alphabetical
order by default, and whether Inbox Insights is switched on for each.

Only verified domains appear. Verifying a domain proves it is yours, which is
what Inbox Insights needs before it will report on it, and a domain that loses
its verification drops out of this list even if it was switched on.

A domain does not have to be ready to send to appear here. Verification and
sending readiness are reported separately on your sending domains, and this
list follows the first.

Use this list to select a verified domain for placement and reputation reports.
The `monitored` field records the workspace's monitoring preference; report access
depends on verified ownership and remains available when monitoring is off.

## Query parameters

- `sending_domain` string
- `search` string
- `sort` 'domain': Field used to sort owned domains.
- `order` 'asc' | 'desc': Sort direction, ascending or descending.
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

A page of the workspace's sending domains and their Inbox Insights status.

- EmailInboxInsightsDomains: A page of sending domains this workspace can report on, and which of them Inbox Insights is switched on for.
  - `data` EmailInboxInsightsDomain[], required: One entry per verified domain in this page, whether or not it is switched on. A domain that has not been verified does not appear, because verification is what proves the domain is yours to report on.
    - `domain` string, required: The sending domain, lowercased, as it appears in your sending domains.
    - `monitored` boolean, required: Whether Inbox Insights reports on this domain. Switching it off stops the reporting and keeps the measurement history, so switching it back on restores the full history rather than starting again.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation.

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)