GET
/
appointments
curl --request GET \
  --url https://api.usecobalt.com/v1/appointments \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>'
{
  "success": true,
  "results": {
    "appointments": [
      {
        "id": "<string>",
        "datetime": "<string>",
        "patient_name": "<string>",
        "mrn": "<string>",
        "status": "<string>"
      }
    ]
  }
}

Authorizations

​
client_id
string
header
required
​
client_secret
string
header
required
​
access_token
string
header
required

Query Parameters

​
start_date
string
required

The start of the date range (ISO 8601 format)

​
end_date
string
required

The end of the date range (ISO 8601 format)

​
patient_mrn
string

The mrn of the patient to filter appointments by

​
patient_name
string

The name of the patient to filter appointments by (case-insensitive, partial match)

​
patient_phone
string

The phone number of the patient to filter appointments by

​
status
string

Only include appointments with the given status

​
include_note
enum<string>

Indicate whether progress notes should be included when available

Available options:
true,
false
​
include_schedule_blocks
enum<string>

Indicate whether schedule blocks (eg. Lunch Break) should be included

Available options:
true,
false
​
appointment_mode
enum<string>

Filter by office or telemedicine appointments

Available options:
office,
telemedicine

Response

200 - application/json

Successful response

The response is of type object.