TWtwinehealth
calendar event

List calendar events

Changed on

Get a list of calendar events

get/calendar_event

Request

  • Base URL
    https://api.twinehealth.com/pub
  • Auth
    none declared

Query parameters

filter[patient]string

Patient id to fetch calendar event. Note that one of the following filters must be specified: filter[patient], filter[group], filter[organization], or filter[attendees].

filter[groups]string

Comma-separated list of group ids. Note that one of the following filters must be specified: filter[patient], filter[group], filter[organization], or filter[attendees].

filter[organization]string

Fitbit Plus organization id. Note that one of the following filters must be specified: filter[patient], filter[group], filter[organization], or filter[attendees].

filter[attendees]string

Comma-separated list of coach or patient ids. Note that one of the following filters must be specified: filter[patient], filter[group], filter[organization], or filter[attendees].

filter[type]'plan-check-in' | 'reminder' | 'telephone-call' | 'office-visit' | 'video-call'

Calendar event type

filter[completed]boolean

If not specified, return all calendar events. If set to true return only events marked as completed, if set to false, return only events not marked as completed yet.

filter[start_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for events starting in November 2017 (America/New_York): filter[start_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

filter[end_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for events ending in November 2017 (America/New_York): filter[end_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

filter[completed_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for events completed in November 2017 (America/New_York): filter[completed_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

filter[created_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for events created in November 2017 (America/New_York): filter[created_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

filter[updated_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for events updated in November 2017 (America/New_York): filter[updated_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

page[number]integer

Page number

page[size]integer

Page size

page[limit]integer

Page limit

page[cursor]string

Page cursor

include'owner'

List of related resources to include in the response

Response

OK

Example response

{
  "data": [
    {
      "type": "calendar_event",
      "id": "5a0c8e2aa9d454cc1509a142",
      "attributes": {
        "completed_at": "2017-11-03T06:17:34.652Z",
        "completed_by": "5a0c8e27a9d454cc150997c9",
        "type": "plan-check-in",
        "time_zone": "America/New_York",
        "all_day": true,
        "start_at": "2017-11-03T04:00:00.000Z",
        "end_at": "2017-11-03T08:00:00.000Z",
        "title": "Plan Check-In",
        "attendees": [
          {
            "_id": "5ac7e74679f6868274a42e28",
            "user": "5a0c8e27a9d454cc150997c9",
            "response_status": "needsAction"
          },
          {
            "_id": "5ac7e74679f6868274a42e27",
            "user": "5a0c8e27a9d454cc150997f7",
            "response_status": "needsAction"
          }
        ],
        "created_at": "2017-10-20T10:59:40.000Z",
        "created_by": "5a0c8e27a9d454cc150997c9",
        "updated_at": "2017-10-20T10:59:40.000Z",
        "updated_by": "5a0c8e27a9d454cc150997c9"
      },
      "relationships": {
        "owner": {
          "links": {
            "related": "/pub/calendar_event/5a0c8e2aa9d454cc1509a142/owner"
          },
          "data": {
            "type": "patient",
            "id": "5a0c8e27a9d454cc150997f7"
          }
        }
      },
      "links": {
        "self": "/pub/calendar_event/5a0c8e2aa9d454cc1509a142"
      }
    }
  ]
}

Changes