カレンダーリスト閲覧

    ログインしたユーザーアカウントのカレンダーリストを閲覧します。

    APIの種類

    サービスAPI

    Request URL

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

    HTTP Method

    GET

    Query Parameters

    パラメータ タイプ 必須 説明
    syncToken String N syncToken以後に修正されたカレンダーのみ閲覧(yyyyMMddHHmmss)
    空の値の場合はすべてのカレンダーリストを取得します。
    showHidden boolean N リストで非表示にしているカレンダーも閲覧するかどうか
    • true：すべてのカレンダーを閲覧
    • false：リストに表示中のカレンダーのみ閲覧

    Response

    プロパティ タイプ 必須 説明
    calendarUid String Y カレンダーID
    displayName String Y カレンダー名
    description String Y カレンダー説明
    ctag String Y カレンダー更新日時(UTC：yyyyMMddHHmmss)
    color String Y カレンダーの色
    dateAlarm String Y 終日予定の通知時間の既定値
    dateTimeAlarm String N 予定の通知時間の既定値
    defaultReminderMedia List Y 既定の通知方法
    enumのvalue: MAIL, POPUP
    showContent boolean Y ブラウザ版でこのカレンダーの予定を表示するかどうか
    showOnList boolean Y カレンダーリストに表示するかどうか
    isDefaultCalendar boolean Y 閲覧するユーザーの基本カレンダーかどうか
    isSharedCalendar boolean Y オーナーが共有したカレンダーかどうか
    calendarMembers List Y カレンダーを共有するメンバーリスト
         member Map Y メンバー
    Mapのkey: type, accountId
         roleId Integer Y 権限タイプ
    1: カレンダーマスター
    2: カレンダーおよび予定の管理
    3: 予定の管理
    4: 予定の詳細を閲覧
    8: 予定の時間枠のみ閲覧
         status String Y メンバーの状態（承諾、未定、辞退）
    • memberのタイプはカレンダーのメンバータイプです。
    • カレンダーのメンバーとなれるタイプは、下記の通りです。
    type 説明
    INDIVIDUAL 個人
    MAILING_LIST グループ
    GROUP 組織
    DOMAIN ドメイン
    TENANT テナント

    Response Example

    [
    {
        "calendarUid": "53114759-1931-4429-a4d2-c3ad14af66db",
        "displayName": "nameOf_99413964194",
        "description": "",
        "ctag": "20201103105039",
        "color": "#FAE3D9",
        "dateAlarm": "-PT12H",
        "dateTimeAlarm": "-PT10M",
        "defaultReminderMedia": [
            "MAIL",
            "POPUP"
        ],
        "showContent": true,
        "showOnList": true,
        "isDefaultCalendar": true,
        "isSharedCalendar": false,
        "calendarMembers": [
            {
                "member": {
                    "accountId": "99413964194@individual.com",
                    "type": "INDIVIDUAL"
                },
                "roleId": 1,
                "status": "ACCEPT"
            }
        ]
    }
]

    Error Code

    HTTPステータス エラーコード 説明
    400 BAD_REQUEST 不正なリクエスト
    403 FORBIDDEN 権限のないリソースへのアクセス
    404 NOT_FOUND 対象リソースがない
    500 INTERNAL_SERVER_ERROR 内部エラー