Skip to main content
GET
Query customer leads

Authorizations

Authorization
string
header
required

Server-only secret key.

Query Parameters

id
string<uuid>

Exact lead ID.

email
string<email>

Exact, case-insensitive email match. Returns at most one lead.

Maximum string length: 320
session_id
string

Exact tenant-unique lead session ID.

Maximum string length: 255
transaction_id
string

Exact transaction ID that marked the lead paid.

Maximum string length: 255
subscription_id
string

Exact subscription ID from the transaction that marked the lead paid.

Maximum string length: 255
status
enum<string>

Restrict results to open or paid leads.

Available options:
lead,
paid
limit
integer
default:50

Maximum records to return, newest updated first.

Required range: 1 <= x <= 100

Response

Matching customer leads.

ok
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required