Lists

List the people on a list

Changed on

Returns the list members, most recently added first. Each row carries a thin person — page this endpoint, then batch GET /api/v1/people for the rest. Pass personId to ask whether one person is on the list: you get their membership, or an empty page if they are not a member.

get/api/v1/lists/{id}/members

Request

Path parameters

idstring uuid required

List ID

Example:3f1c9d2e-8a45-4c7b-9f01-2d6e5b4a7c31

Query parameters

personIdstring uuid

Only return this person's membership — an empty page when they are not a member

pageinteger

Page number (1-indexed)

Example:1
pageSizeinteger

Items per page (max 100)

Example:25
perPageinteger

Alias for pageSize

Response

Paginated members

status'ok' required

Changes