topics

Get contact list metadata

GET /v1/contact-list

Auth required api.topics.view

Returns the org's contact list metadata: name, description, default subscription status, live topic and contact counts, and the last successful sync time (null until the first sync completes). SES allows a single contact list per account, so this returns one object, not a collection.

Returns 404 contact_list_not_synced when the org has no contact list yet — a distinct code from a generic not_found so clients can detect the un-synced state. The list appears automatically once AWS is connected and a sync runs; no client action is required.

Responses

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

200 Contact list metadata application/json

name string required

description string required

default_subscription_status string enum required

One of: OPT_IN, OPT_OUT

topic_count integer<int64> required

contact_count integer<int64> required

last_synced_at string<date-time> | null required

Time of the last successful sync; null until the first sync completes.

401 Missing, malformed, or unknown API key application/problem+json

403 Key lacks the required scope or plan limit violated application/problem+json

404 No contact list synced for this org. The code is contact_list_not_synced. 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