Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
crm
contact

List all contacts

get/crm/{connection_id}/contact

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)

deal_idstring

The deal ID to filter by (reference to CrmDeal)

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
titlestring
companystring
deal_idsstring[]

An array of deal IDs associated with this contact

company_idsstring[]

An array of company IDs associated with this contact

user_idstring
link_urlsstring[]

Additional URLs associated with the contact e.g., LinkedIn, website, etc

departmentstring
image_urlstring
rawobject