List a partner's leads | JazzHQ AI

Returns the leads belonging to one of your partners, newest first.

Archived leads are excluded unless you pass archived=true. Results are always tie-broken by id, so paging through a large result set never skips or repeats a lead.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Path parameters

partnerIdlongRequired

ID of the partner whose leads to list.

Query parameters

pageintegerOptionalDefaults to 0

Zero-based page number.

perPageintegerOptional<=100Defaults to 20

Number of results per page. Values above 100 are rejected.

sortByenumOptionalDefaults to createdAt

Field to sort by. An unrecognised value falls back to createdAt.

Allowed values:

sortDirectionenumOptionalDefaults to desc

Allowed values:

approvalStatusenumOptional

Allowed values:

statuslist of longsOptional

Id of a lead status dropdown value. Repeatable.

sourcelist of longsOptional

Id of a lead source dropdown value. Repeatable.

keywordstringOptional

Case-insensitive prefix match on first name or email address.

createdAtAfterdateOptional

Only leads created on or after this date.

createdAtBeforedateOptional

Only leads created on or before this date.

archivedbooleanOptional

Omit for active leads only. Pass true to list archived leads instead.

Response

Leads retrieved successfully.

successbooleanOptional

messagestring or nullOptional

dataobjectOptional

timestampdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error