Skip to main content
GET
/
appointments
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,
  "appointments": [
    {
      "id": "<string>",
      "ehr_appointment_id": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "duration": 123,
      "status": "<string>",
      "appointment_type": "<string>",
      "appointment_mode": "office",
      "location": "<string>",
      "reason": "<string>",
      "complaint_type": "<string>",
      "patient_name": "<string>",
      "patient_first_name": "<string>",
      "patient_last_name": "<string>",
      "patient_mrn": "<string>",
      "patient_ehr_id": "<string>",
      "patient_dob": "<string>",
      "patient_gender": "<string>",
      "patient_phone": "<string>",
      "provider_ehr_id": "<string>",
      "provider_name": "<string>",
      "provider_npi": "<string>",
      "secondary_provider_ehr_id": "<string>",
      "insurance": "<string>",
      "insurance_number": "<string>",
      "insurance_group_number": "<string>",
      "insurance_subscriber": "<string>",
      "secondary_insurance": "<string>",
      "secondary_insurance_number": "<string>",
      "insurances": [
        {}
      ],
      "diagnoses": [
        {}
      ],
      "medications": [
        {}
      ],
      "note": "<string>",
      "progress_note": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "object_metadata": {
        "source": "cobalt_operation",
        "created_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.usecobalt.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Query Parameters

​
start_date
string<date>
required

The start of the date range (ISO 8601 format)

​
end_date
string<date>
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
​
provider_ehr_id
string

Filter appointments by provider EHR ID

​
location_ehr_id
string

Filter appointments by location EHR ID

​
appointment_type
string

Filter appointments by appointment type (e.g., "New Patient", "Follow Up", "Annual Checkup")

​
secondary_provider_ehr_id
string

Filter appointments by secondary provider EHR ID

Response

200 - application/json

Successful response

​
success
boolean
​
appointments
object[]