Skip to main content
GET
/
leads
List leads
curl --request GET \
  --url https://api.heffl.com/api/v1/leads \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "number": "<string>",
      "name": "<string>",
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "email": "[email protected]",
      "mobile": "<string>",
      "secondaryMobile": "<string>",
      "website": "<string>",
      "value": 123,
      "source": "<string>",
      "stage": "<string>",
      "customFields": "<unknown>"
    }
  ],
  "meta": {
    "count": 123,
    "total": 123,
    "pageNo": 123,
    "pageSize": 123
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

pageNo
number
default:1

Page number (starts from 1)

Required range: x >= 1
pageSize
number
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100

Search by name, email, mobile, or website

archived
boolean

Filter by archived status

stageId
number

Filter by stage ID

Response

200 - application/json

OK

items
object[]
required
meta
object
required