Get Calendar Attendees

    Gets a list of attendees who have permission to use the calendar.

    API Type

    Service API

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v2/users/me/calendarList/{calendarId}/members

    HTTP Method

    GET

    Path Parameters

    Parameter Type Required Description
    calendarId String Y Calendar ID

    Response

    Property Type Required Description
    result String Y API request result
    code Integer Y HTTP status code
    returnValue List Y Calendar attendee’s information objects
        role Map Y Calendar roles
             roleName String Y Role name
    ● master: Master who can add/modify/remove/view events, manage attendees, and close/transfer calendars. It corresponds to Calendar master in the Calendar service.
    ● Staff: Master who can add/modify/remove/view events and manage attendees. It corresponds to Manage calendar and events in the Calendar service.
    ● member: Member who can add/modify/remove/view events. It corresponds to Manage events in the Calendar service.
    ● half_member: Associate member who can view events. It corresponds to Inquire event details in the Calendar service.
    ● subscriber: Subscriber who can view events. This role is not displayed in the Calendar service.
    ● delegater: Delegator who has the same permissions as the Master. It corresponds to Manage events on behalf of master in the Calendar service.
    ● timelookup_only_delegater: Those who can only view whether an event exists at a specific time. It corresponds to Show only the time of the event in the Calendar service.
        roleId Integer Y Role type
    ● 6: Delegator (delegater). It corresponds to Manage events on behalf of master in the Calendar service.
    ● 2: Admin (staff). It corresponds to Manage calendar and events in the Calendar service.
    ● 3: Member (member). It corresponds to Manage events in the Calendar service.
    ● 4: Associate member (half_member). It corresponds to Inquire event details in the Calendar service.
    ● 8: Delegation of time lookups (timelookup_only_delegater). It corresponds to Show only the time of the event in the Calendar service.
        userId String Y Attendee ID
        userName String Y Attendee name
        userType String Y Attendee Type
        email String Y Attendee’s email address
    • 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": [
            {
                "role": {
                    "roleId": 1,
                    "roleName": "master"
                },
                "userType": "INDIVIDUAL",
                "userName": "nameOf_99893883851",
                "userId": "99893883851",
                "email": "99893883851@individual.com"
            },
            {
                "role": {
                    "roleName": "half_member",
                    "roleId": 4
                },
                "userType": "INDIVIDUAL",
                "userName": "nameOf_99892293514",
                "userId": "99892293514",
                "email": "99892293514@individual.com"
            },
            {
                "role": {
                    "roleName": "half_member",
                    "roleId": 4
                },
                "userType": "INDIVIDUAL",
                "userName": "nameOf_99891030894",
                "userId": "99891030894",
                "email": "99891030894@individual.com"
            },
            {
                "role": {
                    "roleName": "half_member",
                    "roleId": 4
                },
                "userType": "INDIVIDUAL",
                "userName": "nameOf_99898846580",
                "userId": "99898846580",
                "email": "99898846580@individual.com"
            }
        ]
    }