View appointment type appointment descriptors

This endpoint returns the EHR appointment descriptors linked to the appointment type for a specific ID, under the institution specified by the subdomain parameter or a specific location within it when appointment types are location specific; location_id is required in that case. descriptor_type is an optional filter, and when location_id is present the results are also limited to that location.

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

NexHealth ID of the appointment type

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

Return only descriptors of this type

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

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
ChangelogMCP serverErrorsdevelopers@nexhealth.com