Skip to main content
GET
Get Leads

Query Parameters

ParameterTypeRequiredDefaultDescription
limitnumberNo50Results per page (1-100)
pagenumberNo1Page number
sortstringNocreatedAt:descSort field and direction
searchstringNo-Search across name, email, phone
fieldsstringNo-Comma-separated fields to return

Filtering

Filters can be applied using query parameters. All filters are optional. Simple filters (exact match):
Multiple values (OR):
Comparison operators:
Existence check:

Filterable Fields

FieldDescription
statusLead status: open, qualified, won, lost
sourceLead source: inbound, gtm, api, manual, wordpress, import
labelIdLabel ID
valueLead value (supports comparison operators)
websiteWebsite URL
createdAtCreation date (supports comparison/exists operators)
updatedAtLast update date (supports comparison/exists operators)
qualifiedAtQualification date (supports comparison/exists operators)

Platform Click IDs

All platform click ID fields support the exists operator.
FieldPlatform
gclidGoogle Ads
dclidGoogle Display Click ID
wbraidGoogle Ads web-to-app click ID
gbraidGoogle Ads app-to-web click ID
ga4cidGoogle Analytics 4 Client ID
ga4sidGoogle Analytics 4 Session ID
fbcMeta (Facebook) Click ID
fbpMeta (Facebook) Browser ID
msclkidMicrosoft Ads
ttclidTikTok
twclidX (Twitter)
rdt_cidReddit
sccidSnapchat
epikPinterest
li_fat_idLinkedIn

UTM Parameters

FieldDescription
utm_sourceUTM source
utm_mediumUTM medium
utm_campaignUTM campaign

Filter Operators

OperatorExampleDescription
(none)?status=wonEquals
[gte]?value[gte]=100Greater than or equal
[gt]?value[gt]=100Greater than
[lte]?value[lte]=1000Less than or equal
[lt]?value[lt]=1000Less than
[exists]?gclid[exists]=trueField is not null / is null

Sorting

Sort by any sortable field with direction:
Multiple sort fields can be combined with commas:
Sortable fields: createdAt, updatedAt, qualifiedAt, value, name, email, status

Field Selection

Request only specific fields to reduce response size:
The id field is always included. Supported field names are the fields shown in Full Lead Object.

Legacy Parameters

For backward compatibility, these legacy parameters are still supported:
LegacyMaps To
updated_afterupdatedAt[gte]
sort=updated_at:descsort=updatedAt:desc

Example Request

Example Response

Error Responses

StatusCodeDescription
400INVALID_FILTERUnknown or invalid filter field
400INVALID_DATEInvalid date value in a date filter
401UNAUTHORIZEDMissing or invalid API key
500INTERNAL_ERRORServer error

Full Lead Object

When no field selection is applied, leads include all available fields:

Authorizations

X-API-KEY
string
header
required

API key for authentication

Query Parameters

limit
integer
default:50

Results per page (1-100)

Required range: 1 <= x <= 100
page
integer
default:1

Page number

Required range: x >= 1
sort
string
default:createdAt:desc

Sort field and direction (e.g. createdAt:desc, value:asc). Multiple fields can be combined with commas.

Example:

"createdAt:desc"

Search across name, email, phone

fields
string

Comma-separated fields to return. The id field is always included.

Example:

"id,name,email,status,value"

status
string

Filter by lead status. Multiple values can be comma-separated.

Example:

"won"

source
enum<string>

Filter by lead source

Available options:
inbound,
gtm,
api,
manual,
wordpress,
import
labelId
string

Filter by label ID

website
string

Filter by website URL

utm_source
string

Filter by UTM source

utm_medium
string

Filter by UTM medium

utm_campaign
string

Filter by UTM campaign

updated_after
string<date-time>

Legacy parameter. Maps to updatedAt[gte].

Response

Paginated list of leads

success
boolean
Example:

true

data
object[]
meta
object