Skip to main content

​
Method

GET /v1/comms/lists/:id

​
Path Parameters

​
id
string
required
The list ID.

​
Headers

​
Authorization
string
required
Bearer token (requires comms:read).

​
Request Example

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

​
Response Example

{
  "id": "lists_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "workspace_id": "workspaces_01HZYPM2QF2R8X9SZQ0J9SYBCN",
  "name": "Newsletter Subscribers",
  "description": "Main newsletter list",
  "source": "signup_form",
  "double_opt_in": true,
  "member_count": 1523,
  "created_at": "2025-01-08T10:22:31.000Z",
  "updated_at": "2025-02-02T14:12:40.000Z"
}