v1

latestOpenAPI 3.0.02026-08-061770538.1 KB

Lead

Returns a paginated list of Leads

Required permission: Leads - List/Search

get/leads

Query parameters

{"stackTrail":"paths:/leads:get:parameters:0:schema:items","oasType":"schema","type":"unknown"}

Array of statuses. Possible values are "New", "Lead", "First Contact", "Opportunity", "Prospect", "Waiting on Client", "In Negotiation", "Pending", "Won", "Lost".

status_liststring

Comma separated list of statuses.

{"stackTrail":"paths:/leads:get:parameters:2:schema:items","oasType":"schema","type":"unknown"}

Array of user IDs.

{"stackTrail":"paths:/leads:get:parameters:3:schema:items","oasType":"schema","type":"unknown"}

Array of Mailbox IDs

has_ticketboolean

querystring

Search query

pageinteger

Returns provided page of results, each 'page' contains 25 results

Response

successful