Get one List by id

Search Documentation

Search across all developer documentation

lists

Get one List by id

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

Returns one static List by id, or 404 not_found when the id is not a List in this org.

Path parameters

id string<uuid> required

Resource UUID. An unparseable id reads as a clean 404 not_found.

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.

origin string enum required

Where the definition is authored. managed Lists are editable via this API; git Lists are synced from a connected repository and read-only here (the repo wins).

One of: managed, git

source_path string optional

Repo-relative list-schema file the definition was synced from. Present only for git-backed Lists.

status string enum required

Provenance-only lifecycle state. archived marks a git-backed List whose key was removed from the repo; it never blocks membership or mailability, and the List reactivates in place if the key returns.

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