Skip to main content
GET
/
leads
List leads
curl --request GET \
  --url https://backend.leadey.ai/v1/leads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "title": "<string>",
      "company": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "linkedinUrl": "<string>",
      "status": "pending",
      "source": "<string>",
      "score": 78,
      "campaignId": "<string>",
      "campaignName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 25,
    "totalCount": 134,
    "totalPages": 6
  }
}

Authorizations

​
Authorization
string
header
required

Your API key, created in the Leadey dashboard under Settings → API Keys. Send it as Authorization: Bearer leadey_sk_live_….

Query Parameters

​
page
integer
default:1

1-based page number.

Required range: x >= 1
​
pageSize
integer
default:25

Items per page (max 100).

Required range: 1 <= x <= 100
​
search
string

Free-text search across the resource's key fields.

​
campaignId
string

Only return leads in this campaign.

​
status
string

Filter by lead status (e.g. pending, replied).

Response

A page of leads.

​
data
object[]
​
meta
object