crm
event

List all events

Changed on
get/crm/{connection_id}/event

Request

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

deal_idstring

The deal ID to filter by (reference to CrmDeal)

contact_idstring

The contact ID to filter by (reference to CrmContact)

company_idstring

The company ID to filter by (reference to CrmCompany)

user_idstring

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

typestring
lead_idstring

The CRM lead ID to filter by (reference to CrmLead)

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 event object

created_atstring date-time

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

updated_atstring date-time

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

type'NOTE' | 'EMAIL' | 'TASK' | 'MEETING' | 'CALL' | 'MARKETING_EMAIL' | 'FORM' | 'PAGE_VIEW'

The type of event

deal_idsstring[]

An array of deal IDs associated with this event

company_idsstring[]

An array of company IDs associated with this event

contact_idsstring[]

An array of contact IDs associated with this event

lead_idsstring[]
user_idstring

(reference to HrisEmployee)

rawobject

The raw data returned by the integration for this event.

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