Skip to main content
GET
Get Leads

Query Parameters

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

Platform Click IDs

All platform click ID fields support the exists operator.

UTM Parameters

Filter Operators

Sorting

Sort by any sortable field with direction:
Multiple sort fields can be combined with commas:
Sortable fields: createdAt, updatedAt, qualifiedAt, value, externalId, 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, including session and sessions.

Legacy Parameters

For backward compatibility, these legacy parameters are still supported:

Example Request

Example Response

Error Responses

Full Lead Object

When no field selection is applied, leads include all available fields. GET responses also include session (the converting pixel session, or null) and sessions (the scoped journey, same shape as session). Flattened click IDs, UTMs, consent, website, and path stay on the lead. Org-internal session fields (organizationId, ip, userAgent, octaCid) are omitted.

Session Object

session is null when the lead has no converting pixel session. sessions is an array of the same object for the scoped journey. Flattened attribution on the lead is unchanged.

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 external ID, name, email, and phone

fields
string

Comma-separated fields to return. The id field is always included. Use session and sessions to include pixel session objects.

Example:

"id,externalId,name,email,status,value"

status
string

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

Example:

"won"

externalId
string

Filter by an exact customer-owned external lead ID

Maximum string length: 255
Example:

"QUOTE-2026-0042"

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