Get Calendars

    Gets calendars associated with a logged-in user's account.

    API Type

    Service API

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v3/users/me/calendarList

    HTTP Method

    GET

    Query Parameters

    Parameter Type Required Description
    syncToken String N Gets only the calendars modified after syncToken (yyyyMMddHHmmss).
    If it is empty, the list of all calendars is returned.
    showHidden Boolean N Indicates whether to include calendars not displayed on the local navigation bar (LNB).
    • true: Get all calendars
    • false: Get only calendars displayed on the LNB.

    Response

    Property Type Required Description
    result String Y API request result
    code Integer Y HTTP status code
    returnValue List Y List of calendars
         owner Map Y Calendar owner.

    Map’s key: type, accountId
         calendarUid String Y Calendar ID
         displayName String Y Calendar name
         description String Y Calendar description
         ctag String Y Indicates whether the calendar is modified.
    It is represented as the time when the calendar is modified, in yyyyMMddHHmmss (TimeZone is represented in UTC).
         color String Y Calendar color
         dateAlarm String Y Default notification time when an all-day event is added.
         dateTimeAlarm String N Default notification time when a default event is added.
         defaultReminderMedia List Y Media to receive default notifications.

    Enum’s value: MAIL, POPUP
         showContent boolean Y Indicates whether the calendar’s events are displayed in the web view.
         showOnList boolean Y Indicates whether the calendar is displayed on the LNB.
         isDefaultCalendar boolean Y Indicates whether it is the user’s default calendar.
         isSharedCalendar boolean Y Indicates whether the calendar is shared by the owner.
         isDelegatedCalendar boolean Y Indicates whether there is a member who was invited as “Manage events on behalf of master.”
         calendarMembers List Y List of members of the calendar.
             delegator Map N For users who are invited as “Manage events on behalf of master,” this property has the information of the user who invited others.

    Map’s key: type, accountId
             member Map Y Invitee.

    Map’s key: type, accountId
             roleId Integer Y Calendar role of the invitee.
    Available values are as follows.

    1: Calendar master
    2: Manage calendar and events
    3: Manage events
    4: Inquire event details
    6: Manage events on behalf of master
    8: Show only the time of the event
             status String Y Indicates whether the invitee accepts, tentatively accepts or rejects the invitation.
    • The type under the delegator, member, and owner properties is the calendar’s member type.
    • The following types can be a member of a calendar.
    type Description
    INDIVIDUAL Individual user
    MAILING_LIST Groups
    GROUP OrgUnit
    DOMAIN Domain
    TENANT Tenant

    Response Example

    {
        "result": "success",
        "code": 200,
        "returnValue": [
            {
                "owner": {
                    "accountId": "99273829825@individual.com",
                    "type": "INDIVIDUAL"
                },
                "calendarUid": "3def9bc2-75f3-42e0-94d7-b31e45153ef9",
                "displayName": "nameOf_99273829825",
                "description": "",
                "ctag": "20191010063603",
                "color": "#E9F1C3",
                "dateAlarm": "-PT12H",
                "dateTimeAlarm": "-PT10M",
                "defaultReminderMedia": [
                    "POPUP",
                    "MAIL"
                ],
                "showContent": true,
                "showOnList": true,
                "isDefaultCalendar": true,
                "isSharedCalendar": false,
                "isDelegatedCalendar": false,
                "calendarMembers": [
                    {
                        "member": {
                            "accountId": "99273829825@individual.com",
                            "type": "INDIVIDUAL"
                        },
                        "roleId": 1,
                        "status": "ACCEPT"
                    }
                ]
            }
        ]
    }