Get sub-calendars

GET {{baseUrl}}/:calendarKeyOrId/subcalendars?includeInactive=false

This API endpoint returns a list of all sub-calendars for the addressed calendar.

Please note that if the used calendar key has administration permission, then active and inactive sub-calendars are returned. Otherwise, only active sub-calendars are returned.

Request Params

KeyDatatypeRequiredDescription
includeInactivebooleanIf true, inactive sub-calendars are included in the response.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Teamup-Tokenstring

RESPONSES

status: OK

{"subcalendars":[{"id":13142976,"name":"Frank","active":true,"color":7,"overlap":true,"readonly":false,"creation_dt":"2024-04-03T16:27:17+00:00","update_dt":null,"type":0,"attributes":[],"number_of_users":4},{"id":13142977,"name":"Linda","active":true,"color":26,"overlap":true,"readonly":false,"creation_dt":"2024-04-03T16:27:17+00:00","update_dt":null,"type":0,"attributes":[],"number_of_users":5},{"id":13142978,"name":"Mark","active":true,"color":24,"overlap":true,"readonly":false,"creation_dt":"2024-04-03T16:27:17+00:00","update_dt":null,"type":0,"attributes":[],"number_of_users":5},{"id":13142979,"name":"Sandy","active":true,"color":10,"overlap":true,"readonly":false,"creation_dt":"2024-04-03T16:27:17+00:00","update_dt":null,"type":0,"attributes":[],"number_of_users":4},{"id":13142980,"name":"Team - all","active":true,"color":14,"overlap":true,"readonly":false,"creation_dt":"2024-04-03T16:27:17+00:00","update_dt":null,"type":0,"attributes":[],"number_of_users":6}]}