Reference/Leads
GET
/v1/leadsList leads
Lists leads in your workspace. Optionally filter to one agent.
Full URL
GET https://api.tryleadreach.com/v1/leads
Headers
X-Api-Key(required): your API key from the app Keys tab.
Path params (in the URL)
None
Query params (after ?)
| Name | Type | Required | Meaning |
|---|---|---|---|
| page | number | No | Which page of results (starts at 1). Default: 1. |
| pageSize | number | No | How many items per page (max 100). Default: 25. |
| agentId | uuid | No | Only leads belonging to this agent. |
Request body (JSON)
None
Example request (JSON)
What you send: headers, and path / query / body when used.
{
"headers": {
"X-Api-Key": "lr_your_key_here"
},
"query": {
"page": 1,
"pageSize": 25,
"agentId": "a1111111-1111-1111-1111-111111111111"
}
}Example response (JSON)
Typical successful response shape.
{
"leads": [
{
"id": "l1111111-1111-1111-1111-111111111111",
"email": "[email protected]",
"status": "new"
}
],
"page": 1,
"pageSize": 25,
"total": 1,
"totalPages": 1
}Response
JSON with "leads" array plus page metadata.
Credits
0