Skip to main content
GET
/
appointment-dashboard
/
by-status
Get Appointments By Status
curl --request GET \
  --url https://api.decodahealth.com/appointment-dashboard/by-status \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "status": "PENDING",
    "count": 123
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
start_date
string<date> | null
​
end_date
string<date> | null
​
timezone
string
required
​
provider_ids
string | null
​
location_ids
string | null

Response

Successful Response

​
status
enum<string>
required
Available options:
PENDING,
RESERVED,
CONFIRMED,
CANCELLED,
COMPLETED,
OVERRIDABLE,
NO_SHOW
​
count
integer
required