GET/calendarevents.json

Get Events

This call will return all calendar events that the current user can see in the provided date range.

Notes

Pagination

By default we'll send back 250 records per page. Inspect the Response Headers for the following values:

  • X-Page (The current page being returned)
  • X-Pages (The total number of pages available)
  • X-Records (The total number of items available
  • You can request a specific page by calling the same API call and adding the parameter &page=n where n is the page you want. e.g: &page=2 for page 2, &page=5 for page 5.

Please note:

The start date and end date are required parameters here. If you do not pass in an end date, it will automatically set it as tomorrow's date.

Query Params

  • Name
    startdate
    Type
    string
    required
    Description

    YYYYMMDD

    Default
  • Name
    endDate
    Type
    string
    required
    Description

    YYYYMMDD

    Default
    tomorrow's date
  • Name
    showDeleted
    Type
    boolean
    Description

    Whether to include deleted events

    Default
    false
  • Name
    updatedAfterDate
    Type
    string
    Description

    Only return events updated after a certain datetime (YYYYMMDDHHMMSS)

  • Name
    eventTypeId
    Type
    integer
    Description

    Only return events with a given eventTypeId (Numeric only - default 0)

  • Name
    page
    Type
    integer
    Description
  • Name
    userId
    Type
    number
    Description

    If you want to bring back records which this user is attending or has created.

  • Name
    attendingOnly
    Type
    boolean
    Description

    If set to true, along with passing in the userId, it will return events that user is attending only. Not ones they have also created.

    Default
    false

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "events": [
    {
      "where": "",
      "project-users-can-edit": false,
      "description": "Some sample Calendar Event",
      "attending-user-ids": "41858",
      "notify-user-names": "",
      "attending-user-names": "Michael H.",
      "status": "active",
      "owner": {
        "first-name": "Billy",
        "id": "29902",
        "last-name": "Mahony"
      },
      "reminders": [],
      "notify-user-ids": "",
      "start": "2014-05-27T00:00",
      "repeat": {},
      "all-day": true,
      "id": "195637",
      "end": "2014-06-10T23:59",
      "show-as-busy": false,
      "last-changed-on": "2014-04-30T11:06:18Z",
      "privacy": {
        "type": "company"
      },
      "attendees-can-edit": false,
      "type": {
        "name": "Holidays",
        "id": "100002",
        "color": "4E9075"
      },
      "title": "MJ Holidays"
    }
  ],
  "STATUS": "OK"
}
Download Swagger