ClientSphereDocs
API reference/Leads

List leads

Returns a paginated list of leads. Supports filtering by stage, source, and search.

GET
/leads

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1
limitinteger

Items per page (max 100)

Default: 20Maximum: 100
searchstring

Search term

stagestring
Value in: "new" | "contacted" | "qualified" | "converted" | "disqualified"
sourcestring
curl -X GET "https://clientsphere.io/api/v1/leads?page=1&limit=20&search=%3Cstring%3E&stage=new&source=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of leads

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "firstName": "string",
      "lastName": "string",
      "email": "user@example.com",
      "phone": "string",
      "jobTitle": "string",
      "companyName": "string",
      "website": "string",
      "industry": "string",
      "companySize": "small",
      "stage": "new",
      "score": 100,
      "source": "website",
      "notes": "string",
      "tags": [
        "string"
      ],
      "assignedTo": 0,
      "disqualifiedReason": "bad_fit",
      "disqualifiedAt": "2019-08-24T14:15:22Z",
      "convertedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

Previous

Delete contact DELETE

Next

Get lead GET