Skip to content

Get Calendars

Endpoint

http
GET /unified/calendar/calendars/{id}
Integrations supported
  • Google Calendar
  • Outlook Calendar

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

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. Defaults to `unified`. `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.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
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.
Example: remote_query[foo]=bar

Response Body

id
string
REQUIRED · The unique identifier of the calendar.
Supported in
  • Google Calendar
  • Outlook Calendar
name
string
The name of the calendar.
Supported in
  • Google Calendar
  • Outlook Calendar
description
string
The description of the calendar.
Supported in
  • Google Calendar
location
object
The location of the calendar.
Supported in
  • Google Calendar
id
string
The unique identifier of the location.
name
string
The name of the location.
status
string
The status of the calendar.
All possible enum values:
  • active
  • inactive
Supported in
  • Google Calendar
visibility
string
The visibility of the calendar.
All possible enum values:
  • public
  • private
Supported in
  • Google Calendar
is_default
boolean
Indicates if the calendar is the default calendar of the user.
Supported in
  • Google Calendar
  • Outlook Calendar
timezone
string
The timezone of the calendar.
Supported in
  • Google Calendar
access_role
object
The access role on the calendar for the authenticated user.
Supported in
  • Outlook Calendar
id
string
The unique identifier of the access role.
name
string
The name of the access role.
All possible enum values:
  • owner
  • reader
  • writer
  • freebusy
colors
object
The colors associated with the calendar.
Supported in
  • Google Calendar
  • Outlook Calendar
background
string
The background color of the calendar.
foreground
string
The foreground color of the calendar.
created_at
string · date-time
The date when the calendar was created.
updated_at
string · date-time
The date when the calendar was updated.
remote_data
object
Raw data returned from the remote API call.