Retrieve an event

GET/crm/{connection_id}/event/{id}

Parameters

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this event object
`created_at`	string (date-time)	No	The date that this event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this event object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`type`	enum	No	The type of event Values: `NOTE`, `EMAIL`, `TASK`, `MEETING`, `CALL`, `MARKETING_EMAIL`, `FORM`, `PAGE_VIEW`
`note`	object	No	The note object, when type = note
`note.description`	string	No	The event note's description
`note.title`	string	No
`meeting`	object	No	The meeting object, when type = meeting
`meeting.start_at`	string (date-time)	No	The event meeting's start datetime (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`meeting.end_at`	string (date-time)	No	The event meeting's end datetime (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`meeting.title`	string	No	The event meeting's topicsubject
`meeting.description`	string	No	The event meeting's agendadescription
`email`	object	No	The email object, when type = email
`email.from`	string	No	The event email's from name & email address (name <test@test.com>)
`email.to`	string[]	No	The event email's "to" name & email (name <test@test.com>)
`email.cc`	string[]	No	The event email's cc name & email (name <test@test.com>)
`email.subject`	string	No	The event email's subject
`email.body`	string	No	The event email's body
`email.attachment_file_ids`	string[]	No
`call`	object	No	The call object, when type = call
`call.duration`	number	No	The event call's duration in minutes
`call.description`	string	No	The event call's descriptionnotes
`call.start_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`task`	object	No	The task object, when type = task
`task.name`	string	No	The event task's nametitle/subject
`task.status`	enum	No	The event task's status Values: `COMPLETED`, `NOT_STARTED`, `WORK_IN_PROGRESS`, `DEFERRED`
`task.description`	string	No	The event task's descriptionnote
`task.due_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`task.priority`	enum	No	Values: `HIGH`, `MEDIUM`, `LOW`
`marketing_email`	object	No
`marketing_email.name`	string	No
`marketing_email.from`	string	No	The event email's from name & email address (name <test@test.com>)
`marketing_email.to`	string[]	No	The event email's "to" name & email (name <test@test.com>)
`marketing_email.cc`	string[]	No	The event email's cc name & email (name <test@test.com>)
`marketing_email.subject`	string	No	The event email's subject
`marketing_email.body`	string	No	The event email's body
`marketing_email.attachment_file_ids`	string[]	No
`form`	object	No
`form.name`	string	No
`form.archived_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`form.fields`	CrmEventFormField[]	No
`form.fields[].name`	string	No
`form.fields[].type`	enum	No	Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `MULTIPLE_CHOICE`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `EMAIL`, `PHONE`, `YES_NO`, `CURRENCY`, `URL`
`form.fields[].options`	CrmEventFormOption[]	No
`form.fields[].options[].label`	string	No
`form.fields[].options[].value`	string	No
`form.fields[].required`	boolean	No
`form.redirect_url`	string	No
`page_view`	object	No
`page_view.count`	number	No
`page_view.average`	number	No
`page_view.url`	string	No
`deal_ids`	string[]	No	An array of deal IDs associated with this event
`company_ids`	string[]	No	An array of company IDs associated with this event
`contact_ids`	string[]	No	An array of contact IDs associated with this event
`lead_ids`	string[]	No	(reference to CrmLead)
`user_id`	string	No	(reference to HrisEmployee)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.crm.getCrmEvent({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/crm/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?