Appearance

List Availability ​

Endpoint ​

http
GET /unified/calendar/availability
Integrations supported
  • Calendly
  • Google Calendar
  • Outlook Calendar

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 availability.

Required in
  • Google Calendar
id
string

The unique identifier of the calendar.

name
string

The name of the calendar.

start_time
string · date-time

The start date and time of the availability slot.

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

The end date and time of the availability slot.

Required in
  • Google Calendar
  • Outlook Calendar
Supported in
  • Calendly
timezone
string

The timezone of the availability slot.

Required in
  • Outlook Calendar
Supported in
  • Google Calendar
emails
array

The emails of the people for whom the availability is to be fetched. By default, the availability of the authenticated user is fetched.

Supported in
  • Outlook Calendar
duration
number

The duration of the availability slot in minutes.

Supported in
  • Outlook Calendar
user
object

The user to filter the availability. Defaults to the authenticated user.

Supported in
  • Calendly
id
string

Unique identifier of a User

Response Body ​

result
object[]

List of Availability

calendar
object

The calendar associated with the availability.

Supported in
  • Google Calendar
id
string

The unique identifier of the calendar.

name
string

The name of the calendar.

email
string

The email of the person associated with the availability.

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

The start date and time of the availability slot.

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

The end date and time of the availability slot.

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

The timezone of the availability slot.

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

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

All possible enum values:
  • busy
  • free
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.