Get one channel by slug

Search Documentation

Search across all developer documentation

entities

Get one channel by slug

GET /v1/channels/{name}
Auth required api.channels.view

Returns one channel by its slug. The path parameter is named name for legacy URL stability, but the expected value is the channel slug (the slug field from the list response), not the human display name. Returns 404 not_found when the slug is unknown.

Path parameters

name string required

Channel slug — the slug field from listChannels, not the display name.

Responses

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

200 Channel detail application/json
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).

401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found 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