List Events ​
Endpoint ​
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
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.
unified
raw
normalized
unified
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.
id
Ignores the limit
query parameter.
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
The calendar associated with the event.
Required in
- Google Calendar
- Outlook Calendar
The unique identifier of the calendar.
The name of the calendar.
The type of the event.
default
focus_time
out_of_office
working_location
Supported in
- Google Calendar
Supported in
- Google Calendar
The field to sort the resource by. Should be in format { fieldName: direction }
. The direction can be asc
or desc
.
Supported in
- Google Calendar
The date when the event was updated.
asc
desc
Supported in
- Google Calendar
The title of the event.
Supported in
- Google Calendar
The description of the event.
Supported in
- Google Calendar
The location of the event.
Supported in
- Google Calendar
The unique identifier of the location.
The name of the location.
The first line of the street address.
The second line of the street address.
The city of the address.
The state of the address.
The country of the address.
The postal code of the address.
The URL of the location.
The latitude of the location.
The longitude of the location.
The person who created the event.
Supported in
- Google Calendar
The unique identifier of the person.
The name of the person.
The emails of the person.
The email of the person.
The type of the email.
The date and time when the event starts.
Supported in
- Google Calendar
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
The timezone of the event.
Supported in
- Google Calendar
The date when the event was updated.
Supported in
- Google Calendar
Response Body ​
List of Events
The unique identifier of the event.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The calendar associated with the event.
Supported in
- Google Calendar
- Outlook Calendar
The unique identifier of the calendar.
The name of the calendar.
The title of the event.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The description of the event.
Supported in
- Google Calendar
- Outlook Calendar
The location of the event.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The unique identifier of the location.
The name of the location.
The first line of the street address.
The second line of the street address.
The city of the address.
The state of the address.
The country of the address.
The postal code of the address.
The URL of the location.
The latitude of the location.
The longitude of the location.
The timezone of the event.
Supported in
- Google Calendar
- Outlook Calendar
The date and time when the event starts.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The date and time when the event ends.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The status of the event.
confirmed
tentative
cancelled
draft
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The attendees associated with the event.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The person associated with the attendee.
The unique identifier of the person.
The name of the person.
The emails of the person.
The email of the person.
The type of the email.
Indicates if the attendance is optional.
Indicates if the attendee is the authenticated user.
Indicates if the attendee is the organizer of the event.
The response of the attendee.
The status of the response.
needs_action
declined
tentative
accepted
The comment of the response.
The person who created the event.
Supported in
- Google Calendar
- Outlook Calendar
The unique identifier of the person.
The name of the person.
The emails of the person.
The email of the person.
The type of the email.
The person who created the event.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The unique identifier of the person.
The name of the person.
The emails of the person.
The email of the person.
The type of the email.
The type of the event.
default
out_of_office
focus_time
working_location
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The availability of the user during the time period of the event.
busy
free
Supported in
- Google Calendar
- Outlook Calendar
The visibility of the event.
calendar_default
public
private
Supported in
- Google Calendar
- Outlook Calendar
The identifiers associated with the event.
Supported in
- Google Calendar
- Outlook Calendar
The iCalendar UID of the event.
The iCalendar sequence of the event.
Indicates if the event is locked and cannot be modified.
Supported in
- Google Calendar
The URLs associated with the event.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The URL of the event.
The type of the URL.
Indicates if the event is recurring.
Supported in
- Google Calendar
- Outlook Calendar
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
The parent event of a recurring event.
Supported in
- Google Calendar
- Outlook Calendar
The unique identifier of the parent event.
Indicates if the event has attachments.
Supported in
- Google Calendar
- Outlook Calendar
The attachments associated with the event.
Supported in
- Google Calendar
The unique identifier of the attachment.
The name of the attachment.
The MIME type of the attachment.
The URL of the attachment.
The date when the attachment was created.
The date when the attachment was updated.
Indicates if guests can invite others to the event.
Supported in
- Google Calendar
Indicates if guests can modify the event.
Supported in
- Google Calendar
Indicates if guests can see other guests of the event.
Supported in
- Google Calendar
The event type object associated with the event.
Supported in
- Calendly
The unique identifier of the event type.
The date when the event was created.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
The date when the event was updated.
Supported in
- Calendly
- Google Calendar
- Outlook Calendar
Raw data returned from the remote API call.
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.