API Reference

View availabilities

get
https://nexhealth.info/availabilities
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Synced or manually created?

Please see the syncedattribute to understand whether this availability was synced from the practice's health record system, or whether it was manually created. See the availabilities landing page to learn more about how this resource works.

Query Params
string
required

Used to scope the request to the specified institution

int32
required

Used to scope the request to the specified location

int32
Defaults to 1

Page number. Starts with page 1

int32
Defaults to 5

Number of results to return per page. Defaults is 5 per page and Max 300 per page

int32

Filter for specific provider

int32

Filter for specific operatory

boolean
Defaults to true

Filter active/not active

boolean
Defaults to false

Filter out availabilities configured for specific dates in the past

include[]
array of strings

Resources to be included in the response

include[]
Allowed:
Responses

Updated 4 days 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/vnd.Nexhealth+json;version=2

Updated 4 days ago

Did this page help you?