Endpoints

View appointment type appointment descriptors (beta)

get
https://nexhealth.info/appointment_types//appointment_descriptors
šŸš§

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: Removes response field data[].last_sync_time.

This endpoint returns EHR appointment descriptors associated with the given appointment type, optionally filtered by descriptor_type or location_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Path Params
int32
required
Query Params
string
required

Used to scope the request to the specified institution

int32

Id of the associated location, required when appointment types are location specific

string

Query by descriptor type

Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

Updated about 2 hours 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 hours ago

Did this page help you?
ChangelogMCP serverErrorsdevelopers@nexhealth.com