Appearance

List Events ​

Endpoint ​

http
GET /unified/calendar/events
Integrations supported
  • Calendly
  • Google Calendar
  • Outlook Calendar
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Calendly

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
calendar
object

The calendar associated with the event.

Required in
  • Google Calendar
  • Outlook Calendar
id
string
REQUIRED · 

The unique identifier of the calendar.

name
string

The name of the calendar.

type
string

The type of the event.

All possible enum values:
  • default
  • focus_time
  • out_of_office
  • working_location
Supported in
  • Google Calendar
identifier
Supported in
  • Google Calendar
  • Outlook Calendar
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • Google Calendar
updated_at
string · date-time

The date when the event was updated.

All possible enum values:
  • asc
  • desc
Supported in
  • Google Calendar
title
string

The title of the event.

Supported in
  • Google Calendar
  • Outlook Calendar
description
string

The description of the event.

Supported in
  • Google Calendar
  • Outlook Calendar
location
object

The location of the event.

Supported in
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the location.

name
string

The name of the location.

address
object
street_1
string

The first line of the street address.

street_2
string

The second line of the street address.

city
string

The city of the address.

state
string

The state of the address.

country
string

The country of the address.

postal_code
string

The postal code of the address.

url
string

The URL of the location.

coordinates
object
latitude
number

The latitude of the location.

longitude
number

The longitude of the location.

organized_by
object

The person who created the event.

Supported in
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the person.

name
string

The name of the person.

emails
object[]

The emails of the person.

email
string

The email of the person.

type
string

The type of the email.

email
string
start_time
string · date-time

The date and time when the event starts.

Supported in
  • Google Calendar
  • Outlook Calendar
end_time
string · date-time

If not specified, fetches events that are within the month of the start_time. If start_time is not specified, fetches events that are till the end of current month.

Supported in
  • Google Calendar
  • Outlook Calendar
timezone
string

The timezone of the event.

Supported in
  • Google Calendar
  • Outlook Calendar
updated_at
string · date-time

The date when the event was updated.

Supported in
  • Google Calendar

Response Body ​

result
object[]

List of Events

id
string
REQUIRED · 

The unique identifier of the event.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
calendar
object

The calendar associated with the event.

Supported in
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the calendar.

name
string

The name of the calendar.

title
string
REQUIRED · 

The title of the event.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
description
string

The description of the event.

Supported in
  • Google Calendar
  • Outlook Calendar
location
object

The location of the event.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the location.

name
string

The name of the location.

address
object
street_1
string

The first line of the street address.

street_2
string

The second line of the street address.

city
string

The city of the address.

state
string

The state of the address.

country
string

The country of the address.

postal_code
string

The postal code of the address.

url
string

The URL of the location.

coordinates
object
latitude
number

The latitude of the location.

longitude
number

The longitude of the location.

timezone
string

The timezone of the event.

Supported in
  • Google Calendar
  • Outlook Calendar
start_time
string · date-time
REQUIRED · 

The date and time when the event starts.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
end_time
string · date-time

The date and time when the event ends.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
status
string

The status of the event.

All possible enum values:
  • confirmed
  • tentative
  • cancelled
  • draft
Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
attendees
object[]

The attendees associated with the event.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
person
object

The person associated with the attendee.

id
string

The unique identifier of the person.

name
string

The name of the person.

emails
object[]

The emails of the person.

email
string

The email of the person.

type
string

The type of the email.

is_optional
boolean

Indicates if the attendance is optional.

is_self
boolean

Indicates if the attendee is the authenticated user.

is_organizer
boolean

Indicates if the attendee is the organizer of the event.

response
object

The response of the attendee.

status
string

The status of the response.

All possible enum values:
  • needs_action
  • declined
  • tentative
  • accepted
comment
string

The comment of the response.

created_by
object

The person who created the event.

Supported in
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the person.

name
string

The name of the person.

emails
object[]

The emails of the person.

email
string

The email of the person.

type
string

The type of the email.

organized_by
object

The person who created the event.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the person.

name
string

The name of the person.

emails
object[]

The emails of the person.

email
string

The email of the person.

type
string

The type of the email.

type
string

The type of the event.

All possible enum values:
  • default
  • out_of_office
  • focus_time
  • working_location
Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
availability
string

The availability of the user during the time period of the event.

All possible enum values:
  • busy
  • free
Supported in
  • Google Calendar
  • Outlook Calendar
visibility
string

The visibility of the event.

All possible enum values:
  • calendar_default
  • public
  • private
Supported in
  • Google Calendar
  • Outlook Calendar
identifiers
object

The identifiers associated with the event.

Supported in
  • Google Calendar
  • Outlook Calendar
ical_uid
string

The iCalendar UID of the event.

ical_sequence
string

The iCalendar sequence of the event.

is_locked
boolean

Indicates if the event is locked and cannot be modified.

Supported in
  • Google Calendar
urls
object

The URLs associated with the event.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
url
string

The URL of the event.

type
string

The type of the URL.

is_recurring
boolean

Indicates if the event is recurring.

Supported in
  • Google Calendar
  • Outlook Calendar
recurrence
string[]

The recurrence of the event. List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.

Supported in
  • Google Calendar
  • Outlook Calendar
parent_event
object

The parent event of a recurring event.

Supported in
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the parent event.

has_attachments
boolean

Indicates if the event has attachments.

Supported in
  • Google Calendar
  • Outlook Calendar
attachments
object[]

The attachments associated with the event.

Supported in
  • Google Calendar
id
string

The unique identifier of the attachment.

name
string

The name of the attachment.

mime_type
string

The MIME type of the attachment.

url
string

The URL of the attachment.

created_at
string · date-time

The date when the attachment was created.

updated_at
string · date-time

The date when the attachment was updated.

guests_can_invite_others
boolean

Indicates if guests can invite others to the event.

Supported in
  • Google Calendar
guests_can_modify
boolean

Indicates if guests can modify the event.

Supported in
  • Google Calendar
guests_can_see_other_guests
boolean

Indicates if guests can see other guests of the event.

Supported in
  • Google Calendar
event_type
object

The event type object associated with the event.

Supported in
  • Calendly
id
string

The unique identifier of the event type.

created_at
string · date-time

The date when the event was created.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
updated_at
string · date-time

The date when the event was updated.

Supported in
  • Calendly
  • Google Calendar
  • Outlook Calendar
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.