Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NexHealth Institutions API

An organization containing at least one location is refered to as Institution

NexHealth Institutions API is one of 33 APIs that NexHealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Institutions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version v20240412.

Requests are made against a single base URL, https://nexhealth.info.

2 operations 2 paths 8 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v20240412
Base URL
https://nexhealth.info
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

NexHealth Institutions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Institutions 2

An organization containing at least one location is refered to as Institution

GET
/institutions
View institutions
getInstitutions → 200401500
GET
/institutions/{id}
View institution
getInstitutionsId 1 param → 200400401404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are API_V2_Entities_Institution (12 properties), API_Entities_LocationBasic (10 properties), API_V2_Entities_Institution_Collection_Response (5 properties), API_V2_Entities_Institution_Response (5 properties). Each schema is shown below with its type and property counts.

API_Errors_InternalServerError
object
APIErrorsInternalServerError model
4 properties
API_Errors_Unauthorized
object
APIErrorsUnauthorized model
4 properties
API_Errors_BadRequest
object
APIErrorsBadRequest model
4 properties
API_V2_Entities_Institution_Collection_Response
object
APIV2EntitiesInstitutionCollectionResponse model
5 properties
API_V2_Entities_Institution_Response
object
APIV2EntitiesInstitutionResponse model
5 properties
API_V2_Entities_Institution
object
12 properties
API_Errors_NotFound
object
APIErrorsNotFound model
4 properties
API_Entities_LocationBasic
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexhealth-institutions-api-openapi.yml Raw ↑

Other APIs NexHealth publishes across the network.

NexHealth Adjustment Types API
NexHealth Adjustments API
NexHealth Appointment Types API
NexHealth Appointments API
NexHealth Authenticates API
NexHealth Available Slots API
NexHealth Balances API
NexHealth Charges API
NexHealth Claims API
NexHealth Clinical Notes API
NexHealth Document Types API
NexHealth Fee Schedules API