Skip to main content
GET
List leads

Authorizations

Authorization
string
header
required

Enter your JWT token in the format: Bearer

Query Parameters

assignment_tab
enum<string>

Filter by assignment state relative to the calling user. pending / ongoing resolve via the assignment-service; completed / rejected resolve locally via LeadParticipant. Users with sales:oversight see all leads by status regardless of assignee. Omit to return all leads visible to the caller.

Available options:
completed,
ongoing,
pending,
rejected
bse
string

Filter by BSE UUID (LeadParticipant.user_id). Returns leads where this user appears as a participant. Executed as a single SQL subquery — no per-row lookups.

category
string

Filter by LeadCategory.name, case-insensitive. e.g. Direct, Agency, Digital, Government.

cursor
string

The pagination cursor value.

node
string

Filter by current workflow node code (exact match). e.g. NODE_LEAD_NURTURING, GATE_PROPOSAL_APPROVED.

page_size
integer

Number of results to return per page.

Case-insensitive substring search across name, reference, contact_person, contact_phone, and contact_email.

Response

200 - application/json
results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"