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

HHAeXchange Internal API

The Internal API from HHAeXchange — 3 operation(s) for internal.

HHAeXchange Internal API is one of 3 APIs that HHAeXchange publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Internal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a status page, and rate-limit docs.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.hhaexchange.com.

3 operations 3 paths 6 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.hhaexchange.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

HHAeXchange Internal API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (bearerAuth) using the clientCredentials flow, exposing 1 scope.

Paths & Operations 3

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

Internal 3
GET
/v1/internal/provider
Get provider details
get_provider_v1_internal_provider_get 4 params → 200422
GET
/v1/internal/generic-references
Get generic references
get_generic_references_v1_internal_generic_references_get 4 params → 200422
GET
/v1/internal/payer
Get payer details (FHIR Aggregator or FhirPayer)
get_payer_v1_internal_payer_get 2 params → 200422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ProviderDetailsResponse (12 properties), PayerDetailsResponse (9 properties), GenericReferencesResponse (3 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

GenericReferenceItem
object
Single generic reference item from GenericReferences table.
3 properties 2 required
ValidationError
object
3 properties 3 required
HTTPValidationError
object
1 property
GenericReferencesResponse
object
Response for GET /internal/generic-references: list of generic references by CompanyID and ReferenceType.
3 properties 2 required
ProviderDetailsResponse
object
Response for GET /internal/provider: base URL, provider and user details, environment, validation.
12 properties
PayerDetailsResponse
object
Response for GET /internal/payer: aggregator client, first active mapping as payer context.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhaexchange-internal-api-openapi.yml Raw ↑

Other APIs HHAeXchange publishes across the network.

HHAeXchange Configuration API
HHAeXchange Onboarding API