Retrieve Leads

Returns a list of leads in JSON format based on the provided filters and query parameters.

Query Params
string
required

The Dataset ID

string
Defaults to *

Keyword or phrase to search across all searchable fields. Search is case-insensitive for text fields. Defaults to '*' to match all results.

int32
Defaults to 50

No of rows to return in response.

string
Defaults to en_US

Locale for formatting the 'prettyLastEvent' field in response. Determines the language and regional formatting (e.g., dates, text) returned by the API.

string

Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.

string

Text-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated.

string

Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max.

string
required

Time-based filter expression used to filter results by time field. Format: field|operator|value.

Allowed fields (same as timeField parameter):

  • eventEsTimestamp : Last Seen
  • first_session_unix_timestamp : First Seen

Supported operators:

  • exactly → integer value (0 = Today, 1 = Yesterday)
  • lessthan → integer value (e.g. 6 = last 7 days)
  • between → date range in format dd/MM/yyyy-dd/MM/yyyy

Locale settings are taken into account while interpreting dates and returning results.

string

Field-based filter used to include leads based on field presence.

Format: operator|field1;field2

Allowed operator:

  • hasanyvalue

Allowed fields:

  • firstName
  • lastName
  • email

Multiple fields can be provided using semicolons.

string

Exit link filter used to include or exclude leads based on exit link values.

Format: field|operator|value

Supported operators:

  • contains
  • is
  • isnot
  • doesnotcontain

Multiple values can be provided using semicolons.

int32
0 to 100

Minimum lead score threshold (optional). Only records with lead scores greater than the provided number (0–100) are returned.

string

Display filter used to control which types of leads are returned.

Supported values:

  • company
  • person
  • unidentified

Selecting 'unidentified' returns leads that could not be identified as a company or a person.

Multiple values can be provided using semicolons.

string
enum
required
Defaults to eventEsTimestamp

Time field used for filtering.

Allowed values:

  • eventEsTimestamp : Last Seen
  • first_session_unix_timestamp : First Seen
Allowed:
int64
string
Defaults to Europe/Amsterdam

Time zone used when parsing timestamps and evaluating time-based filters. If not provided, the default time zone is Europe/Amsterdam.

string

Sort results by a specific field and direction.

Format: field|direction

Allowed fields:

  • lastEvent
  • _score

Allowed directions:

  • asc
  • desc
Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json