List Members

Retrieve members of a marketing list with optional filtering.

Method

GET /v1/comms/lists/:id/members

Path Parameters

id · string · required

The list ID.

Query Parameters

status · string

Filter by member status (subscribed, unsubscribed, cleaned, bounced).

limit · number

Maximum number of results (1-100, default 50).

offset · number

Number of results to skip for pagination (default 0).

Headers

Authorization · string · required

Bearer token (requires comms:read).

Request Example

cURL

curl "https://api.voyantcloud.com/v1/comms/lists/lists_01J0CBFPXW7SP2N8A9Q7T2048Q/members?status=subscribed" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response Fields

Each member item includes:

• id – Member ID.
• list_id – List ID.
• person_id – Person ID.
• status – Member status (subscribed, unsubscribed, cleaned, bounced).
• source – How the member was added (manual, import, api, form).
• subscribed_at – When the member subscribed.
• unsubscribed_at – When the member unsubscribed (if applicable).
• created_at – ISO timestamp.
• person – Person details (id, first_name, last_name, email).

Response Example

200 OK

{
  "items": [
    {
      "id": "list_members_01J0CBFPXW7SP2N8A9Q7T2048Q",
      "list_id": "lists_01J0CBFPXW7SP2N8A9Q7T2048Q",
      "person_id": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
      "status": "subscribed",
      "source": "api",
      "subscribed_at": "2025-01-08T10:22:31.000Z",
      "unsubscribed_at": null,
      "created_at": "2025-01-08T10:22:31.000Z",
      "person": {
        "id": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[e-mail]"
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}