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

HealthSherpa Utility API

The Utility API from HealthSherpa — 1 operation(s) for utility.

HealthSherpa Utility API is one of 5 APIs that HealthSherpa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Utility. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

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

1 operations 1 paths 2 schemas 1 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.one.healthsherpa.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HealthSherpa Utility API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 1

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

Utility 1
GET
/v1/ping
Confirm API reachability and key validity
ping → 200403429500502503504

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PingResponse (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

PingResponse
object
2 properties 2 required
ErrorResponse
object
Canonical error envelope returned by HealthSherpa-owned API endpoint, infrastructure filter, and backend service failures. The direct enrollment endpoints retu…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

healthsherpa-utility-api-openapi.yml Raw ↑

Other APIs HealthSherpa publishes across the network.

HealthSherpa Enrollment Sessions API
HealthSherpa Enrollments API
HealthSherpa Quotes API
HealthSherpa Reference API