View an appointment type (beta)

🚧

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 param source; adds response fields data.active, data.data_source_id, data.display_name, data.foreign_id (+2 more); removes response field data.descriptors[].last_sync_time.

This endpoint returns a single appointment type by its NexHealth ID; when descriptors are included via the include param, location_id is required. Appointment types synced from the EHR are only found with source=synced or source=all.

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 and when including sub-resources

string
enum
Defaults to manual

Which appointment types to return: managed in NexHealth (manual), synced from the EHR (synced), or both (all)

Allowed:
include[]
array of strings

Resources to be included in the response

include[]
Allowed:
Headers
string
required
Defaults to v3.1.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/json
ChangelogMCP serverErrorsdevelopers@nexhealth.com