List Calendars
/unified/calendar/calendars
Query Parameters
Refer Specifying query parameters in Truto APIs
The access role on the calendar for the authenticated user.
1 supported
The unique identifier of the access role.
The name of the access role.
freebusyownerreaderwriter
By default, inactive calendars are not included in the response. To include them, set this parameter to "inactive". The "active" calendars are always included in the response.
activeinactive
2 supported
By default, private calendars are not included in the response. To include them, set this parameter to "private". The "public" calendars are always included in the response.
privatepublic
2 supported
The user whose calendars are to be retrieved.
1 supported
The unique identifier of the user.
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
Defaults to unified.
unifiedunifiedrawnormalizedstream
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.
idIgnores 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[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
List of Calendars
The unique identifier of the calendar.
4 supported
The access role on the calendar for the authenticated user.
1 supported
2 properties
The unique identifier of the access role.
The name of the access role.
ownerreaderwriterfreebusy
The colors associated with the calendar.
3 supported
2 properties
The background color of the calendar.
The foreground color of the calendar.
The date when the calendar was created.
The description of the calendar.
3 supported
Indicates if the calendar is the default calendar of the user.
3 supported
The location of the calendar.
2 supported
2 properties
The unique identifier of the location.
The name of the location.
The name of the calendar.
4 supported
Raw data returned from the remote API call.
The status of the calendar.
activeinactive
2 supported
The timezone of the calendar.
2 supported
The date when the calendar was updated.
The visibility of the calendar.
publicprivate
2 supported
curl -X GET 'https://api.truto.one/unified/calendar/calendars?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/calendar/calendars?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/calendar/calendars"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'calendar',
'calendars',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"calendar",
"calendars",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())