List channels (SES configuration sets)

Search Documentation

Search across all developer documentation

entities

List channels (SES configuration sets)

GET /v1/channels
Auth required api.channels.view

Returns the org's channels — each backed by an AWS SES configuration set with its TLS, tracking, and suppression policy. Identities currently bound to each channel are included in the response so you can see at a glance which addresses send through which channel. Sorted newest-first.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Channels, newest-first application/json
data array<object> required

Each entry in data:

name string required

Human display name.

slug string required

URL-safe key. Use this in GET /v1/channels/{name}.

status string enum required

One of: active, discovered, detached, archived, pending

tracking_domain string | null required

SES configuration-set CustomRedirectDomain. Null when not set. May or may not match a SendOps-managed tracking-domain row.

suppression_policy array<string enum> required

SES suppression reasons applied to this channel. Empty array means the channel does not opt into account-level suppression for any reason.

identities array<string> required

Sending identities currently bound to this channel. Items are full email addresses or bare domains (whatever was bound), not slugs.

created_at string<date-time> required

When this channel was first registered with SendOps (not the SES config-set creation time).

pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json