crm
contact

List all contacts

get/crm/{connection_id}/contact

Request

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

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

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

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
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

Unique identifier for this contact object

created_atstring date-time

The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the contact

first_namestring
last_namestring
titlestring

The job title of the contact

companystring

The companyorganization name of the contact

deal_idsstring[]

An array of deal IDs associated with this contact

company_idsstring[]

An array of company IDs associated with this contact

user_idstring

(reference to HrisEmployee)

link_urlsstring[]

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

departmentstring
image_urlstring
rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.