PropelBiz34leadsLeadsCRUD

List Leads

View as Markdown
List Leads visible to the current tenant + tenant_location. **Query params (all optional):** - `assigned_user_id` (uuid): filter by assignee - `lead_stage_id` (uuid): filter by stage - `lead_source_id` (uuid): filter by source - `is_open` (bool): only non-terminal leads - `is_converted` (bool): only converted leads - `follow_up_due` (bool): only leads whose `follow_up_at` is past-due - `search` (string max 255): match name / business_name - `per_page` (int 1-100, default 15) - `cursor` (string): cursor pagination token

Headers

{{tenant_key_name}}stringOptional

Query parameters

assigned_user_idstringOptional

Optional: Assignee UUID

lead_stage_idstringOptional

Optional: Lead stage UUID

lead_source_idstringOptional

Optional: Lead source UUID

is_openstringOptional

Optional: true|false

is_convertedstringOptional

Optional: true|false

follow_up_duestringOptional

Optional: true|false

searchstringOptional

Optional: search term - max 255

per_pageintegerOptional

Optional: Results per page (default 15, max 100)

cursorstringOptional

Optional: Cursor pagination token

Response

Successful response