leads_get
Retrieves a listing of CRM leads in JSON format
Name | Type | Required | Example |
---|---|---|---|
user_id | Integer | N | 1001 Filter userID if ai_token is not present |
search_params | String | N | Received URL asearch params normally in the lead_management URL (includes statues/tags/etc) |
page_size | Integer | N | 20 Specify a maximum amount of results to receive |
page_number | Integer | N | 1 Specify a starting page (limit is page_size) |
limit_fields | String | N | id,status CSV list of lead fields to return. All other lead data will be excluded. |
Name | Type | Example |
---|---|---|
num_results | Integer | 1 |
total_results | Integer | 1 |
leads | Array | of leads |