Skip to main content
GET
Get all leads

Authorizations

Authorization
string
header
required

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

FlowAuthorization Code
Authorization URL
https://dev.flextell.ai/oauth/authorize
Token URL
https://dev.flextell.ai/oauth/token

Headers

X-Tenant
number
required

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

Query Parameters

lead_status_id
integer | null

Filter by lead status ID.

lead_reference_source_id
integer | null

Filter by lead reference source ID.

converted
boolean | null

Filter by converted status (true for converted leads).

search
string | null

The search query.

Maximum string length: 255
sort_by
enum<string> | null

The field to sort by.

Available options:
created_at,
last_name,
first_name,
converted_at,
last_synced_at
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
trashed
boolean | null

Include only soft-deleted records.

Response

Paginated set of LeadResource

data
LeadResource · object[]
required
meta
object
required