Retrieve an event

GET/calendar/{connection_id}/event/{id}

Parameters

Returns

Response field	Type	Required	Description
`id`	string	No
`created_at`	string	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`calendar_id`	string	No	(reference to CalendarCalendar)
`subject`	string	No
`start_at`	string	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`end_at`	string	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`is_all_day`	boolean	No
`timezone`	string	No
`notes`	string	No
`location`	string	No
`is_free`	boolean	No
`is_private`	boolean	No
`status`	enum	No	Values: `CANCELED`, `CONFIRMED`, `TENTATIVE`
`organizer`	object	No
`organizer.user_id`	string	No	(reference to HrisEmployee)
`organizer.email`	string	No
`organizer.name`	string	No
`organizer.status`	enum	No	Values: `ACCEPTED`, `REJECTED`, `TENTATIVE`
`organizer.required`	boolean	No
`organizer.is_cohost`	boolean	No
`attendees`	CalendarAttendee[]	No
`attendees[].user_id`	string	No	(reference to HrisEmployee)
`attendees[].email`	string	No
`attendees[].name`	string	No
`attendees[].status`	enum	No	Values: `ACCEPTED`, `REJECTED`, `TENTATIVE`
`attendees[].required`	boolean	No
`attendees[].is_cohost`	boolean	No
`recurring_event_id`	string	No	(reference to CalendarEvent)
`recurrence`	CalendarEventRecurrence[]	No
`recurrence[].frequency`	enum	No	Values: `DAILY`, `WEEKLY`, `MONTHLY`, `YEARLY`
`recurrence[].interval`	number	No	how many "units" between occurrences, defaults to 1
`recurrence[].count`	number	No	how many occurrences, defaults to undefined (no limit)
`recurrence[].end_at`	string (date-time)	No	until date, defaults to undefined (no end date) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`recurrence[].on_days`	enum[]	No	days of the week to repeat on, defaults to undefined (every day), only used if frequency is WEEKLY Values: `SU`, `MO`, `TU`, `WE`, `TH`, `FR`, `SA`
`recurrence[].on_months`	object	No	months of the year to repeat on, defaults to undefined (every month), only used if frequency is YEARLY, January is 1
`recurrence[].on_month_days`	object	No	days of the month to repeat on, defaults to undefined (every day), only used if frequency is MONTHLY
`recurrence[].on_weeks`	object	No	week ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals.
`recurrence[].on_year_days`	object	No	days of the year to repeat on, defaults to undefined (every day), only used if frequency is YEARLY
`recurrence[].week_start`	enum	No	week start day, defaults to undefined (no week start day) Values: `SU`, `MO`, `TU`, `WE`, `TH`, `FR`, `SA`
`recurrence[].excluded_dates`	object	No	dates to exclude from the recurrence, defaults to undefined (no exclusions)
`recurrence[].included_dates`	object	No	dates to include in the recurrence, defaults to undefined (no inclusions)
`recurrence[].timezone`	string	No	timezone, defaults to undefined (no timezone)
`web_url`	string	No
`has_conference`	boolean	No
`conference`	CalendarConference[]	No
`conference[].conference_identifier`	string	No
`conference[].url`	string	No
`conference[].label`	string	No
`conference[].telephone`	string	No
`conference[].participant_access_code`	string	No
`conference[].host_access_code`	string	No
`conference[].notes`	string	No
`conference[].country_code`	string	No	ISO 2-digit country code
`conference[].region_code`	string	No	ISO 2-digit region code
`attachments`	CalendarAttachment[]	No
`attachments[].id`	string	No	ID for the storage_fileget endpoint
`attachments[].name`	string	No
`attachments[].mime_type`	string	No
`attachments[].download_url`	string	No
`send_notifications`	boolean	No
`matter_id`	string	No	pointer to Legal Matter

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/calendar/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.calendar.getCalendarEvent({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/calendar/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/calendar/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/calendar/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/calendar/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/calendar/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/calendar/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/calendar/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?