Skip to main content
GET
Get all leads

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

pipeline_stage_id
integer | null

Filter by pipeline stage ID.

lead_reference_source_id
integer | null

Filter by lead reference source ID.

assigned_user_id[]
integer[]

An assigned user ID to filter by.

converted
boolean | null

Filter by converted status (true for converted leads).

active
boolean | null

Filter by active status: true returns leads that are neither converted nor in a won or lost stage (the definition the lead cap and the salesperson's active_lead_count use), false returns the rest.

search
string | null

The search query.

Maximum string length: 255
created_at_from
string<date-time> | null

Filter by creation date (inclusive lower bound).

created_at_to
string<date-time> | null

Filter by creation date (inclusive upper bound).

converted_at_from
string<date-time> | null

Filter by conversion date (inclusive lower bound).

converted_at_to
string<date-time> | null

Filter by conversion date (inclusive upper bound).

sort_by
enum<string>

The field to sort by.

Mevcut seçenekler:
created_at,
last_name,
first_name,
converted_at,
last_synced_at
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1

Yanıt

Paginated set of LeadResource

data
LeadResource · object[]
gerekli
meta
object
gerekli