Get Lead List
API key access
leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/lists/{list_id}Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
uuidHeader Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/lists/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Workspace-Id: string"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"kind": "static",
"filters": {
"status": [
"string"
],
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"q": "string",
"title": "string",
"industry": "string",
"country": "st",
"replied": true
},
"member_count": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Enroll Lead List
Enroll the list's leads in a campaign (at most 1000; 422 `list_too_large`, `empty_list`). The same checks as enrolling leads one by one apply: leads already in the campaign are skipped, and consent, suppressions and sending limits are checked before anything is sent. Enrolling doesn't start the campaign.
List Lead List Members
The list's leads, newest first (a segment's are the leads matching its filters now).