🚧

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 provider_id, source; changes query param include[]; 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 appointment types for the institution; when descriptors are included via the include param, location_id is required. Pass provider_id to only return appointment types offered by that provider. By default only appointment types managed in NexHealth are returned; pass source=synced for those synced from the EHR or source=all for both. working_hour_ids is only returned when included via include and is limited to the given location_id.