List Leads
Leads in the workspace, newest first (cursor pagination).
API key access
leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/leadsAccess 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
Query Parameters
Repeat to match any of
uuiduuidName, email or company name contains
length <= 200Only leads with this language (a code like hi or pt-BR, or a common language name; RO-253)
length <= 35Sort by this field instead of newest first (then by id); the cursor of a sorted page only continues that sort
Direction of sort (default asc; nulls last)
"asc" | "desc"next_cursor of the previous page (at most 64 characters without sort)
length <= 2048int641 <= value <= 200Header Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/leads?status=new&owner_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&company_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&q=string&language=string&order=asc&cursor=string&limit=1" \ -H "X-Workspace-Id: string"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"first_name": "string",
"last_name": "string",
"title": "string",
"email": "string",
"phone": "string",
"phone_type": "mobile",
"linkedin_url": "string",
"timezone": "string",
"language": "string",
"status": "new",
"source": "string",
"custom_fields": {
"property1": null,
"property2": null
},
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"company": {},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}