LeadReach AI - GET List all agents Docs

GET/v1/agents

List all agents

Returns agents in your workspace. Use page and pageSize if you have many.

Full URL

GET https://api.tryleadreach.com/v1/agents

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.

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
  }
}

Example response (JSON)

Typical successful response shape.

{
  "agents": [
    {
      "id": "a1111111-1111-1111-1111-111111111111",
      "name": "Outbound",
      "status": "active",
      "campaignId": "c1111111-1111-1111-1111-111111111111"
    }
  ],
  "page": 1,
  "pageSize": 25,
  "total": 1,
  "totalPages": 1
}

Response

JSON with "agents" array plus page, pageSize, total, totalPages.