API Service Documentation

Command: leads_get

Retrieves a listing of CRM leads in JSON format

Request

NameTypeRequiredExample
user_idIntegerN1001

Filter userID if ai_token is not present

search_paramsStringNReceived

URL asearch params normally in the lead_management URL (includes statues/tags/etc)

page_sizeIntegerN20

Specify a maximum amount of results to receive

page_numberIntegerN1

Specify a starting page (limit is page_size)

Response

NameTypeExample
num_resultsInteger1
total_resultsInteger1
leadsArrayof leads