Skip to main content
GET
List leads
Required scopes: leads.read

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Query Parameters

source
string
Maximum string length: 500
medium
string
Maximum string length: 500
campaign
string
Maximum string length: 500
conversion_type
enum<string>

Filters leads by an approved conversion type.

Available options:
public_quiz,
onsite_form,
partner_api,
jobnimbus_import,
sms_inbound,
phone_call
communication_channel
enum<string>

Filters leads that have at least one approved communication event in the channel.

Available options:
call,
sms
lead_type
string

Filters leads by Lead type. Send the key or the current label of a workspace lead type. An unknown value returns VALIDATION_ERROR.

Maximum string length: 100
from
string<date-time>

Inclusive updated_at lower bound for incremental sync. ISO 8601 date-time with Z or a ±HH:MM offset. Encode + as %2B.

to
string<date-time>

Inclusive updated_at upper bound for incremental sync. ISO 8601 date-time with Z or a ±HH:MM offset. Encode + as %2B.

status_stage_id
string
Maximum string length: 150
Maximum string length: 200
cursor
string

Opaque cursor returned by list/export responses. Send it back unchanged; malformed cursors return 400.

Maximum string length: 500
limit
integer
default:50

Page size of a lead list, from 1 to 100. A higher value does not return 400; the server uses 100. The export ignores this value and returns up to 500 leads per response. A page can contain fewer leads than this value, or none, while has_more is true. Keep requesting with the returned cursor until has_more is false.

Required range: x >= 1

Response

Active leads page.

leads
object[]
required
pagination
object
required