Get one List

Search Documentation

Search across all developer documentation

lists

Get one List

GET /v1/lists/{id}
Auth required api.lists.view

Returns one static List by its org-unique key or its id, or 404 not_found when the handle names no List in this org.

Path parameters

id string required

The List's UUID or, when the value does not parse as a UUID, its org-unique key. Unknown handles read as 404 not_found. Accepted on every List route, read and write alike.

Responses

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

200 The List application/json
id string<uuid> required
name string required
key string required

Org-unique slug, stable across renames.

description string required
source string enum required

How the List was created.

One of: api, ui, import, topic_export

member_count integer<int64> required

Cached count of current members.

status string enum required

Lifecycle state. archived never blocks membership or mailability.

One of: active, archived

created_at string<date-time> required
updated_at string<date-time> required
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
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