Skip to main content
GET
Returns a paginated list of leads for the project associated with your API key. Supports filtering, searching, and sorting.

Query parameters

Pagination

number
default:"50"
Number of leads per page. Min: 1, max: 100.
number
default:"1"
Page number (1-indexed).

Filtering

string
Filter by lead status. Supports comma-separated values for multiple statuses (e.g. open,pending).
string
Filter by form name.
string
Filter by unique identifier (exact match). Returns leads that match the user-provided CRM or external system ID.
string
Filter by email address (exact match).
string
Filter by phone number (exact match).
string
Only return leads created on or after this date (ISO 8601 format).
string
Only return leads created on or before this date (ISO 8601 format).
Search across first name, last name, email, phone, and company name. Minimum 2 characters.

Sorting

string
default:"createdAt:desc"
Sort field and direction, formatted as field:direction. Allowed fields: createdAt, firstName, lastName, email, price, status. Directions: asc, desc.

Attribution filters

boolean
Filter leads that have (true) or don’t have (false) a Google Click ID.
boolean
Filter leads that have (true) or don’t have (false) a Client ID.
boolean
Filter leads that have (true) or don’t have (false) a Facebook Browser ID.
boolean
Filter leads that have (true) or don’t have (false) a Facebook Click ID.

Response

string
"Leads retrieved".
object[]
Array of lead objects. See Get Lead for the full lead object shape.
number
Total number of leads matching the filters.
number
Current page number.
number
Number of leads per page.
number
Total number of pages.
boolean
Whether there are more pages after the current one.