bird email inbox-insights domains list

Usage

Code example

bird email inbox-insights domains list [flags]

List verified sending domains owned by the workspace and their monitoring settings. Follow next_cursor with starting_after, keeping filters and ordering. A monitored value records the workspace setting; it does not establish that vendor measurements exist.

API-key calls require Insights preview access for your organization.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example

bird email inbox-insights domains list
bird email inbox-insights domains list | jq -r '.data[].domain'
bird email inbox-insights domains list --limit 50 --starting-after <cursor>

Options

Pagination

Name	Description
--ending-before	Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--limit <n>	Maximum number of items to return per page.
--order	Sort direction. Defaults to asc, which sorts alphabetically or from oldest to newest, depending on the selected sort field. Possible values: asc, desc.
--sort	Field to sort by. Defaults to domain. Possible values: domain.
--starting-after	Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

Name	Description
--response-schema	Print the fields this command returns, then exit
--search	Substring match against the sending domain (case-insensitive).
--sending-domain	Exact sending domain to return. Matching is case-insensitive.

Name	Description
bird email inbox-insights domains update	Switch Inbox Insights on or off for a sending domain

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integration Implementation guideSend your first email

Get an implementation brief