v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
crm
lead

List all leads

get/crm/{connection_id}/lead

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

company_idstring

The company ID to filter by (reference to CrmCompany)

contact_idstring

The contact ID to filter by (reference to CrmContact)

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
first_namestring
last_namestring
user_idstring
creator_user_idstring
contact_idstring
company_idstring
company_namestring
is_activeboolean
sourcestring
statusstring
link_urlsstring[]
rawobject