List static Lists

Search Documentation

Search across all developer documentation

lists

List static Lists

GET /v1/lists
Auth required api.lists.view

Returns the org's static Lists, newest-first. A List is an explicit, operator-managed membership set — a contact stays a member until it is removed or deleted. Segments (/v1/segments) are the dynamic, predicate-driven counterpart. Definition writes (create/edit/delete) are available under api.lists.manage; membership add/remove lives on the contacts surface (lists on /v1/contacts). Cursors are opaque base64; stale or malformed cursors silently fall back to page 1.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

Responses

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

200 Cursor-paginated list of Lists, newest-first application/json
data array<object> required

Each entry in data:

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
pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated 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