ユーザーの基本カレンダーの取得

GET/users/{userId}/calendar

ユーザーの基本カレンダーを取得する。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

calendar
calendar.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/calendar

Path Parameters

ParameterTypeDescription
userIdstringユーザーを特定するID - ユーザーID(userId) - ログインID(email) - 自身(me)
required
example : me

Header Parameters

HeadertypeDescription
AuthorizationstringBearer {token}
required

Response

HTTP 200

OK

PropertyTypeDescription
calendarIdstringカレンダーID
required
minLength : 1
calendarNamestringカレンダー名
required
minLength : 1
membersarray (object)共有ユーザーリスト
required
minItems : 0
descriptionstringカレンダー説明
isPublicbooleanDefault : false 公開フラグ
calendarEmailstringカレンダーの固有メールアドレス 共有カレンダーに予定を登録する際、Organizer.email に入力する値。 例) "organizer": { "email": "{calendarEmail}" }

object

PropertyTypeDescription
idstringユーザーID(userId)/組織ID(orgUnitId)/グループID(groupId)
required
minLength : 1
typestringユーザータイプ - USER : ユーザー - GROUP : グループ - ORGUNIT : チーム(組織)
required
enum : USER, GROUP, ORGUNIT
rolestringユーザー権限 - CALENDAR_EVENT_READ_WRITE : カレンダーおよび予定の管理 - EVENT_READ_WRITE : 予定の管理 - EVENT_READ : 予定の詳細の閲覧 - EVENT_READ_FREE_BUSY : 予定の時間枠のみ閲覧
required
enum : CALENDAR_EVENT_READ_WRITE, EVENT_READ_WRITE, EVENT_READ, EVENT_READ_FREE_BUSY

HTTP 403

Forbidden

HTTP 404

Not Found