How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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), GenericReferenceItem (3 properties). Each schema is shown below with its type and property counts.

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

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
Where this information came from

This is an independent, third-party profile of HHAeXchange Internal API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.