crm
lead

List all leads

Changed on
get/crm/{connection_id}/lead

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/crm/{connection_id}/lead
  • Auth: API key in header authorization

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
first_namestring
last_namestring
user_idstring

(reference to HrisEmployee)

creator_user_idstring

(reference to HrisEmployee)

contact_idstring

(reference to CrmContact)

company_idstring

(reference to CrmCompany)

company_namestring
is_activeboolean
sourcestring
statusstring
titlestring

The job title of the lead

link_urlsstring[]
rawobject

Changes