Method
GET /v1/comms/lists/:id
Path Parameters
string
required
The list ID.
Headers
string
required
Bearer token (requires
comms:read).curl "https://api.voyantcloud.com/v1/comms/lists/lists_01J0CBFPXW7SP2N8A9Q7T2048Q" \
-H "Authorization: Bearer $VOYANT_API_KEY"
const listId = "lists_01J0CBFPXW7SP2N8A9Q7T2048Q"
const res = await fetch(`https://api.voyantcloud.com/v1/comms/lists/${listId}`, {
headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
})
const list = await res.json()
import os, requests
list_id = "lists_01J0CBFPXW7SP2N8A9Q7T2048Q"
resp = requests.get(
f"https://api.voyantcloud.com/v1/comms/lists/{list_id}",
headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)
list_data = resp.json()
{
"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"
}
{
"error": "List not found"
}
Communications
Get List
Retrieve details of a specific marketing list.