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.

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
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 A query parameter, path value or body field failed validation. The body is a validation_failed Problem. When the refusal is about a reference — a segment key, template slug, topic or attribute name the organization does not have — it additionally carries validation_code, field, line/column, missing, candidates and next_step, so a client can correct the call without a second round of guessing. See ValidationProblem. 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