DRdrchrono
Clinical

GET /api/appointments

Changed on

Retrieve or search appointment or breaks. <b>Note:</b> Either since, occurred_since, date or date_range parameter must be specified. results returned in order of scheduled date. <b>Note:</b> Membership plan charges get a placeholder appointment per billing cycle and are returned by default. They are marked with is_membership_appointment, and exclude_membership=true leaves them out.

Request

  • Base URL
    https://app.drchrono.com
  • URL
    https://app.drchrono.com/api/appointments
  • Auth
    OAuth 2
    Authorization code: https://app.drchrono.com/o/authorize/
    Token URL: https://app.drchrono.com/o/token/ scopes: calendar:read, calendar:write, clinical:read, clinical:write

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

statusstring

Appointment status name

patientinteger

Patient ID

officeinteger

Office ID

doctorinteger

Doctor ID

sincestring

Lower bound inclusive date filter for appointment updated/created date

occurred_sincestring

Filter appointments based on scheduled time

date_rangestring

Inclusive upper and lower bound filter for appointment scheduled date. Format: yyyy-mm-dd/yyyy-mm-dd. Max window size 190 days

verboseboolean

set to true to include clinical_note, custom_fields, custom_vitals, extended_updated_at, reminders, status_transitions, vitals but limit page_size to 25

datestring

Specific date filter for appointment scheduled date

ignore_virtualboolean

Do not include virtual appointments that have not yet been materialized. This is useful when you need to get a list of appointments that are materialized and ready to be used.

set to true to ignore virtual appointments that have not yet been materialized

show_archivedboolean

Include archived or deleted appointments in the response

set to true or 1 to include deleted or archived appointments

exclude_membershipboolean

Leave membership plan charge appointments out of the response

set to true or 1 to leave out membership plan charge appointments, which are internal placeholders rather than real visits. See is_membership_appointment

Response

OK

OR

Changes

  • 98cabe79d150Revision changes
    • info

      added the new optional query request parameter exclude_membership

  • 1f92de898aecRevision changes
    • breaking

      added subschema #1: AvailabilityDateRangeResponse subschema #2: AvailabilitySingleDateResponse to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status