uc
contact

List all contacts

Changed on
get/uc/{connection_id}/contact

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/uc/{connection_id}/contact
  • 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

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 company/organization name of the contact

rawobject

The raw data returned by the integration for this contact

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status