Skip to content

Latest commit

 

History

History
143 lines (130 loc) · 3.09 KB

events.md

File metadata and controls

143 lines (130 loc) · 3.09 KB

Read Events

GET /events

Description

Returns events.

Required Scope

  • calendar.event.read

Request

Headers

Name Required Description
Authorization yes Bearer token.

Query Parameters

Name Required Description Data Type
from yes Lower bound (inclusive) to filter by. date-time
to yes Upper bound (exclusive) to filter by. date-time
limit no Maximum number of events returned on one result page. (Default: 5) integer
page no Which result page to return. (Default: 1) integer
category no Category of events to filter by. string
orderBy no The order of the events returned in the result and filter by. The value must be "start", "end", "created_at" or "updated_at". (Default: start) string

Example

GET /events?from=2015-01-01T00%3A00%3A00.000Z&to=2016-01-01T00%3A00%3A00.000Z&limit=5&page=1&category=%E5%AD%B8%E7%94%9F&orderBy=start

Response

Formats

  • json

Structure

Field Name Type Value Description
events array List of Event Objects
count integer Number of events.
page integer Page number of events.

Example

{
  "events": [
    {
      "id": "a2frtf13cuaqhit9pf26lqmvr4",
      "created_at": "2015-11-03T07:45:34.000+08:00",
      "updated_at": "2015-11-03T07:45:34.000+08:00",
      "summary": "Test Summary1",
      "description": "Test Description1",
      "location": "Test Location1",
      "category": "學生",
      "start": "2016-01-01T08:00:00.000+08:00",
      "end": "2016-07-01T09:00:00.000+08:00",
      "link": "http://example1.com"
    },
    {
      "id": "bitvsriapjap4023c75d7mints",
      "created_at": "2015-11-03T07:45:54.000+08:00",
      "updated_at": "2015-11-03T07:45:54.000+08:00",
      "summary": "Test Summary2",
      "description": "Test Description2",
      "location": "Test Location2",
      "category": "學生",
      "start": "2016-07-01T08:00:00.000+08:00",
      "end": "2017-01-01T09:00:00.000+08:00",
      "link": "http://example2.com"
    }
  ],
  "count": 2,
  "page": 1
}