Skip to main content
GET
/
calendar
/
appointment-checklist
Get Event Appointment Checklist
curl --request GET \
  --url https://api.decodahealth.com/calendar/appointment-checklist \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "eventId": "<string>",
    "name": "<string>",
    "optional": true,
    "position": 123,
    "serviceId": "<string>",
    "type": "FILLED_FORM",
    "completedDate": "2023-11-07T05:31:56Z",
    "completedByUser": {
      "id": "<string>",
      "type": "PROVIDER",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>"
    }
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
event_id
string
required

Response

Successful Response

​
id
string
required
​
eventId
string
required
​
name
string
required
​
optional
boolean
required
​
position
integer
required
​
serviceId
string | null
​
type
enum<string> | null
Available options:
FILLED_FORM,
CHECKED_IN,
WITH_MA,
MEASUREMENT_TAKEN,
DOSE_TAKEN,
WITH_PROVIDER,
NOTE_TAKEN,
PAYMENT_MADE,
REQUEST_GFE
​
completedDate
string<date-time> | null
​
completedByUser
UserTiny · object