Skip to main content
GET
/
calendar
/
event
/
list
List Events
curl --request GET \
  --url https://api.decodahealth.com/calendar/event/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "title": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "type": "APPOINTMENT",
    "status": "PENDING",
    "location": {
      "id": "<string>",
      "isVirtual": true
    },
    "attendees": [],
    "recurringEventId": "<string>",
    "recurringEvent": {
      "id": "<string>",
      "rrule": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "durationMinutes": 123,
      "timezone": "<string>",
      "type": "APPOINTMENT",
      "title": "<string>",
      "organizerId": "<string>",
      "serviceIds": [
        "<string>"
      ],
      "capacity": 123,
      "attendeeIds": [
        "<string>"
      ],
      "locationId": "<string>"
    },
    "eventServices": [],
    "icons": [],
    "capacity": 123
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
user_ids
string[] | null
​
types
enum<string>[] | null
Available options:
APPOINTMENT,
SHIFT,
BLOCK
​
statuses
enum<string>[] | null
Available options:
PENDING,
RESERVED,
CONFIRMED,
CANCELLED,
COMPLETED,
OVERRIDABLE,
NO_SHOW
​
start
string<date-time> | null
​
end
string<date-time> | null
​
location_ids
string[] | null

Response

Successful Response

​
id
string
required
​
title
string
required
​
start
string<date-time>
required
​
end
string<date-time>
required
​
type
enum<string>
required
Available options:
APPOINTMENT,
SHIFT,
BLOCK
​
status
enum<string>
required
Available options:
PENDING,
RESERVED,
CONFIRMED,
CANCELLED,
COMPLETED,
OVERRIDABLE,
NO_SHOW
​
location
LocationTiny · object
​
attendees
AttendeeDetail · object[]
​
recurringEventId
string | null
​
recurringEvent
RecurringEventDetail · object
​
eventServices
EventServiceTiny · object[]
​
icons
enum<string>[]
Available options:
BOOKING_FEE_PAID,
NEW_PATIENT,
SCHEDULED_BY_AI,
FORM_COMPLETED,
CHECKED_IN
​
capacity
integer | null