API Reference

View appointments

get
https://nexhealth.info/appointments

This endpoint returns the appointments starting within the requested time window, narrowed down by the optional filters configured. At least one of location_id or foreign_id must be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Used to scope the request to the specified institution

int32

Used to scope the request to the specified location

string

Optional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields:

  • updated_at
  • -updated_at
date-time
required

A parseable date string defining the earliest returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000

date-time
required

A parseable date string defining the last returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000

string

Timezone for the appointment clinic

boolean

Filter by cancelled status.

boolean

Unavailable appointments are used to block availability on a schedule, specify to set the filter

boolean

Only show appointments booked via NexHealth API

date-time

Query appointments whose records have updated since the specified datetime in ISO8601 format. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDT00:00:00+0000

int32

Get appointments for a specific appointment type

string

Unique appointment id from the EHR

int32

Query appointments that were created by a specific user

string

First item of the current page. Starts empty

string

Last item of the current page. Starts empty

int32
Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

patient_ids[]
array of int32s

Get appointments for specific patients (up to 25 ids)

patient_ids[]
provider_ids[]
array of int32s

Query appointments that are booked with the specified providers only

provider_ids[]
operatory_ids[]
array of int32s

Query appointments that are booked in the specified operatories only

operatory_ids[]
Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?