Skip to main content
GET
List leads

Authorizations

x-api-key
string
header
required

Query Parameters

[limit]
integer

How many records to return, at most 250.

Required range: 1 <= x <= 250
[offset]
integer

How many records to skip.

Required range: x >= 0
[project]
string

Comma-separated list of fields to return, e.g. id,createdAt.

Minimum string length: 1
[with]
string

Comma-separated list of relations to populate.

Minimum string length: 1
source
string

Only leads captured by this chatbot id.

Minimum string length: 1
ads
enum<string>

Filters by the ad click id found in originURL. organic means none of them.

Available options:
all,
organic,
google,
meta,
tiktok

Response

Success

data
object[]
required
hasMore
boolean
required
limit
number
required
offset
number
required
total
number
required