Skip to main content
POST
List leads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A search string to search the leads against - can be First Name, Last Name, or Email

Example:

"John Doe"

filter
string

Filter criteria for leads. For custom lead labels, use the interest_status field.

Example:

"FILTER_VAL_CONTACTED"

campaign
string<uuid>

Campaign ID to filter leads

Example:

"019f985c-867f-70c7-8151-22007312d922"

list_id
string<uuid>

List ID to filter leads

Example:

"019f985c-867f-70c7-8151-2201798704a9"

in_campaign
boolean

Whether the lead is in a campaign

Example:

true

in_list
boolean

Whether the lead is in a list

Example:

true

ids
string<uuid>[]

Array of lead IDs to include

queries
object[]
excluded_ids
string<uuid>[]

Array of lead IDs to exclude

contacts
string<email>[]

Array of emails the leads needs to have

limit
integer

The number of items to return

Required range: 1 <= x <= 100
Example:

10

starting_after
string

Forward pagination cursor. When distinct_contacts is false, provide the id value from the last lead of the previous page; when true, provide the lead's email.

Example:

"019f985c-935f-7e57-9f82-511f8d6b6a9e"

organization_user_ids
string<uuid>[]

Array of organization user IDs to filter leads

smart_view_id
string<uuid>

Smart view ID to filter leads

Example:

"019f985c-935f-7e57-9f82-5121854a6593"

is_website_visitor
boolean

Whether the lead is a website visitor

Example:

true

distinct_contacts
boolean

Whether to return distinct contacts

Example:

true

enrichment_status
enum<number>

Enrichment status to filter leads

Available options:
1,
-1,
11,
-2
Example:

1

esg_code
enum<string>

ESG code to filter leads

Available options:
0,
1,
2,
3,
4,
all,
none
Example:

"1"

Response

The list of Lead

items
Lead · object[]
required

The list of Lead

next_starting_after
string

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example:

"019f985c-935f-7e57-9f82-512211f319d6"