GET/users/{userId}/calendar-personals

Gets a list of private properties of calendars that a specified user can access.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

calendar.read
calendar

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

User ID


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
count integer 

Number of items to get


default : 50
minimum : 1
maximum : 50
example : 50
format : int32 
cursor string 

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
calendarPersonals array (CalendarPersonal) 

Collection of private properties of the calendar

 
responseMetaData object (responseMetaData) 

Response metadata

 

CalendarPersonal

PropertyTypeDescription
calendarId string 

Calendar ID


required 
calendarName string 

Calendar name


required
maxLength : 50 
isShowOnLNBList boolean 

Indicates whether to make the calendar visible on the calendar list.


required 
displayOrder integer 

Display order


required
minimum : 0
maximum : 9999
format : int32 
resourceLocation integer 

Code of an instance containing CalendarShared information


required 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


required 

Response Example

example

1{2  "calendarPersonals": [3    {4      "displayOrder": 9999,5      "calendarId": "calendar-96b8-4c74-8277-7953e0b4604a",6      "calendarName": "nameOf_99517579704",7      "isShowOnLNBList": true,8      "resourceLocation": 141019    },10    {11      "displayOrder": 1,12      "calendarId": "021aca65-c92c-4523-b2cf-f7afe8d46ca8",13      "calendarName": "nameOf_33617579704",14      "isShowOnLNBList": true,15      "resourceLocation": 1410116    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}

HTTP 403

Forbidden

HTTP 404

Not Found