Get contact list metadata

Search Documentation

Search across all developer documentation

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

200 Contact list metadata application/json
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