Get Events

    Gets a specified user’s events during a specified period. The period can be up to 30 days.

    API Type

    Service API

    Request URL

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

    HTTP Method

    GET

    Path Parameters

    Parameter Type Required Description
    calendarId String Y Calendar ID. Set this parameter to “defaultCalendarId” to get events from the default calendar.

    Query Parameters

    Parameter Type Required Description
    rangeDateFrom String Y Start date (yyyyMMdd).
    The date is inclusive.
    rangeDateUntil String Y End date (yyyyMMdd).
    The date is exclusive.

    Response

    Property Type Required Description
    result String Y API request result
    code Integer Y HTTP status code
    returnValue List Y Array of event objects
         accountId String Y User’s email address (accountId for the Lite product)
         calendarId String Y Calendar ID
         ical String Y iCalendar string
         viewUrl String Y URL to view events

    Response Example

    {
        "result": "success",
        "code": 200,
        "returnValue": [
            {
                "accountId": "testEmail@worksmobile.com",
                "calendarId": "8a5ae051-0f5b-4937-b243-7f28f4f758e8",
                "ical": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Michael Angstadt//biweekly 0.4.2//EN\r\nBEGIN:VEVENT\r\nDTSTAMP:20191008T080713Z\r\nUID:test_createSchedule_c30660ce-bb9f-47f5-9347-f927fd73d7a9\r\nSUMMARY:summary\r\nDTSTART:20181231T150000Z\r\nDTEND:20181231T160000Z\r\nSEQUENCE:0\r\nX-NAVER-REGISTERER;X-WORKSMOBILE-WID\u003d99976234990;CUTYPE\u003dINDIVIDUAL:\r\nCREATED:20191008T080713Z\r\nLAST-MODIFIED:20191008T080713Z\r\nX-NAVER-LAST-MODIFIER;X-WORKSMOBILE-WID\u003d99976234990;CUTYPE\u003dINDIVIDUAL;CN\u003dnameOf_99976234990:\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
                "viewUrl": "https://calendar.worksmobile.com/permanentLink.nhn?url\u003dhttps://calendar.worksmobile.com/schedule.nhn#%7B%22sSection%22:%22scheduleEdit%22,%22oParameter%22:%7B%22sAction%22:%22modify%22,%22calendarId%22:%228a5ae051-0f5b-4937-b243-7f28f4f758e8%22,%22scheduleUid%22:%22test_createSchedule_c30660ce-bb9f-47f5-9347-f927fd73d7a9%22,%22scheduleId%22:%22test_createSchedule_c30660ce-bb9f-47f5-9347-f927fd73d7a9%22,%22selectedDate%22:%222018-12-31%2015:00:00%22%7D%7D"
            }
        ]
    }