View working hours (beta)

get

https://nexhealth.info/working_hours

🚧
Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query params appointment_type_id, schedule_template_id; adds response fields data[].appointment_types[].active, data[].appointment_types[].data_source_id, data[].appointment_types[].display_name, data[].appointment_types[].foreign_id (+13 more).

This endpoint returns the working hours of the specified location. Every filter is optional.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

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

provider_id

int32

Filter for specific provider

operatory_id

int32

Filter for specific operatory

label_id

int32

Filter by specific label

source

string

enum

Filter by source of working hour

Allowed:

active

boolean

Defaults to true

true returns only active records, false only inactive. Defaults to true

ignore_past_dates

boolean

Defaults to false

Filter out working hours configured for specific dates in the past

appointment_type_id

int32

Only working hours that offer this appointment type. With EHR restrictions enabled for the location: through an allow restriction, or any type a restriction does not exclude, or a manual mapping when the working hour has no restrictions; otherwise through a manual mapping. Block working hours never match

schedule_template_id

int64

Only working hours that belong to this schedule template

include[]

array of strings

Resources to be included in the response

include[]

Allowed:

Headers

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error