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

H1 Ribbon Cost Estimates & Eligibility API

Procedure cost estimates and insurance eligibility - submit eligibility checks and retrieve supported eligibility insurance partners and estimated procedure costs.

H1 Ribbon Cost Estimates & Eligibility API is one of 9 APIs that H1 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 75 operations across 57 paths, organized into 11 resource areas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

75 operations 57 paths 0 schemas 7 DELETE41 GET8 POST19 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ribbonhealth.com/v1
Authentication
HTTP Bearer
Resource Areas
11

Authentication & Security 1

H1 Ribbon Cost Estimates & Eligibility API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 75

Across 57 paths, the API surfaces 75 operations — 7 DELETE, 41 GET, 8 POST, 19 PUT. They span 11 resource areas, including Providers, Filters, Locations, Reference Endpoints, Focus Area Endpoints, Organizations, TINs, Virtual Care Platforms, and 3 more. Each is listed below with its method, path, parameters, and response codes.

Providers 11
GET
/custom/providers
Search Providers
getCustomProviders 10 params → 200400403
GET
/custom/providers/{npi}
Get Provider
getCustomProvider 2 params → 200403404
PUT
/custom/providers/{npi}
Modify Provider Fields
putCustomProvider 1 param body → 200400403404
PUT
/custom/providers/{npi}/locations
Add Or Remove Provider Locations
putCustomProviderLocations 1 param body → 200400403404
PUT
/custom/providers/{npi}/locations/{location_uuid}
Modify Provider Location Fields
putCustomProviderLocation 2 params body → 200400403404
PUT
/custom/providers/{npi}/specialties
Add Or Remove Provider Specialties
putCustomProviderSpecialties 1 param body → 200400403404
PUT
/custom/providers/{npi}/specialties/{specialty_uuid}
Modify A Provider's Primary Specialties
putCustomProviderPrimarySpecialties 2 params body → 200400403404
PUT
/custom/providers/{npi}/procedures
Add Or Remove Provider Procedures
putCustomProviderProcedures 1 param body → 200400403404
PUT
/custom/providers/{npi}/clinical_areas
Add Or Remove Provider Clinical Areas
putCustomProviderClinicalAreas 1 param body → 200400403404
PUT
/custom/providers/{npi}/locations/{location_uuid}/insurances
Add Or Remove Provider Insurances At A Location
putCustomProviderLocationInsurances 2 params body → 200400403404
PUT
/custom/providers/{npi}/locations/{location_uuid}/organizations
Add Or Remove Provider Organizations At A Location
putCustomProviderLocationOrganizations 2 params body → 200400403404
Filters 8
GET
/custom/providers/filters
Get Provider Filters
getCustomProviderFilters → 200
POST
/custom/providers/filters
Create Provider Filter
createCustomProviderFilter body → 201400409
PUT
/custom/providers/filters/{filter_uuid}
Edit Provider Filter
editCustomProviderFilter 1 param body → 200400404409
DELETE
/custom/providers/filters/{filter_uuid}
Delete Provider Filter
deleteCustomProviderFilter 1 param → 204404
GET
/custom/locations/filters
Get Location Filters
getCustomLocationFilters → 200
POST
/custom/locations/filters
Create Location Filter
createCustomLocationFilter body → 201400409
PUT
/custom/locations/filters/{filter_uuid}
Edit Location Filter
editCustomLocationFilter 1 param body → 200400404409
DELETE
/custom/locations/filters/{filter_uuid}
Delete Location Filter
deleteCustomLocationFilter 1 param → 204404
Locations 8
GET
/custom/locations
Search Locations
getCustomLocations 5 params → 200400403
POST
/custom/locations
Create Location
postCustomLocations body → 201400409
GET
/custom/locations/{location_uuid}
Get Location
getCustomLocation 1 param → 200404
PUT
/custom/locations/{location_uuid}
Add or Edit Location Fields
putCustomLocation 1 param body → 200400404
DELETE
/custom/locations/{location_uuid}
Delete Location
deleteCustomLocation 1 param → 204404
PUT
/custom/locations/{location_uuid}/insurances
Add Or Remove Location Insurances
putCustomLocationInsurances 1 param body → 200400404
PUT
/custom/locations/{location_uuid}/organizations
Add Or Remove Location Organizations
putCustomLocationOrganizations 1 param body → 200400404
PUT
/custom/locations/{location_uuid}/clinical_areas
Add Or Remove Location Clinical Areas
putCustomLocationClinicalAreas 1 param body → 200400404
Reference Endpoints 23
GET
/custom/insurances
Search Insurances
getInsurances 1 param → 200400
POST
/custom/insurances
Create Insurance
postCustomInsurance body → 201400409
GET
/custom/insurances/{insurance_uuid}
Get Insurance
getCustomInsurance 1 param → 200404
PUT
/custom/insurances/{insurance_uuid}
Edit Insurance Fields
putCustomInsurance 1 param body → 200400404409
DELETE
/custom/insurances/{insurance_uuid}
Delete Insurance
deleteCustomInsurance 1 param → 204404
GET
/custom/specialties
Search Specialties
getSpecialties 1 param → 200403
POST
/custom/specialties
Create Specialty
postCustomSpecialty body → 201400409
GET
/custom/specialties/{specialty_uuid}
Get Specialty
getCustomSpecialty 1 param → 200404
PUT
/custom/specialties/{specialty_uuid}
Edit Specialty Fields
putCustomSpecialty 1 param body → 200400404409
DELETE
/custom/specialties/{specialty_uuid}
Delete Specialty
deleteCustomSpecialty 1 param → 204404
GET
/provider_types
Search Provider Types
getCustomProviderTypes 1 param → 200
POST
/custom/provider_types
Create Provider Type
postCustomProviderType body → 201400409
GET
/custom/provider_types/{provider_type_uuid}
Get Provider Type
getCustomProviderType 1 param → 200404
PUT
/custom/provider_types/{provider_type_uuid}
Edit Provider Type Fields
putCustomProviderType 1 param body → 200400403404409
DELETE
/custom/provider_types/{provider_type_uuid}
Delete Provider Type
deleteCustomProviderType 1 param → 204403404
GET
/location_types
Search Location Types
getCustomLocationTypes 1 param → 200
POST
/custom/location_types
Create Location Type
postCustomLocationType body → 201400409
GET
/custom/location_types/{location_type_uuid}
Get Location Type
getCustomLocationType 1 param → 200404
PUT
/custom/location_types/{location_type_uuid}
Edit Location Type Fields
putCustomLocationType 1 param body → 200400403404409
DELETE
/custom/location_types/{location_type_uuid}
Delete Location Type
deleteCustomLocationType 1 param → 204403404
GET
/procedures
Search Procedures
getProcedures 4 params → 200
GET
/procedures/{procedure_uuid}
Get Procedure
getProcedure 1 param → 200404
GET
/languages
Search Languages
getLanguages 1 param → 200
Focus Area Endpoints 6
GET
/custom/clinical_areas
Search Clinical Areas
getClinicalAreas 1 param → 200400
GET
/custom/clinical_areas/{clinical_area_uuid}
Get Clinical Area
getClinicalArea 1 param → 200404
GET
/custom/conditions
Search Conditions
getConditions 1 param → 200400
GET
/custom/conditions/{condition_uuid}
Get Condition
getCondition 1 param → 200404
GET
/custom/treatments
Search Treatments
getTreatments 1 param → 200
GET
/custom/treatments/{treatment_uuid}
Get Treatment
getTreatment 1 param → 200404
Organizations 2
GET
/custom/organizations
Search Organizations
getOrganizations 6 params → 200
GET
/custom/organizations/{organization_uuid}
Get Organization
getOrganization 1 param → 200404
TINs 2
GET
/custom/tin
Search TINs
getTins 1 param → 200403
GET
/custom/tin/{tin_id}
Get TIN
getCustomTin 1 param → 200404
Virtual Care Platforms 2
GET
/custom/virtual_care_platforms
Search Virtual Care Platforms
getCustomVirtualCarePlatforms 1 param → 200400
GET
/custom/virtual_care_platforms/{virtual_care_platform_uuid}
Get Virtual Care Platform
getVirtualCarePlatform 1 param → 200404
Price Transparency 8
GET
/pricing/providers
Provider Price Search
getPricingProviders 1 param → 200400
GET
/pricing/providers/{npi}/procedures
Provider Procedures
getPricingProviderProcedures 4 params → 200400404
GET
/pricing/providers/{npi}/procedures/{procedure_uuid}
Provider Procedure Pricing
getPricingProviderProcedure 5 params → 200400404
GET
/pricing/providers/{npi}/procedures/{procedure_uuid}/locations/{location_uuid}
Provider Location Procedure Pricing
getPricingProviderProcedureLocation 4 params → 200400404
GET
/pricing/carriers
List Carriers
getPricingCarriers → 200
GET
/pricing/carrier/{carrier_uuid}
Get Carrier
getPricingCarrier 1 param → 200404
GET
/pricing/versiondeprecated
Carrier Names
getPricingCarrierNames → 200
GET
/pricing/version/{carrier_name}deprecated
Carrier Data Versions By Name
getPricingVersionCarrier 1 param → 200404
Cost Estimates 4
POST
/eligibility
Check Member Eligibility
getEligibility 1 param body → 200
GET
/eligibility_insurance_partners
Search Supported Eligibility Insurances
getEligibilityInsurancePartners 1 param → 200
GET
/eligibility_insurance_partners/{insurance_partner}
Get Eligibility Insurance
getEligibilityInsurancePartner 1 param → 200404
GET
/procedure_cost_estimate
Procedure Cost Estimate
getProcedureCostEstimate 4 params → 200
Networks 1
GET
/network_analysis
Network Analysis Based on Geography
getNetworkAnalysis 3 params → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ribbon-health-api-openapi.json Raw ↑

Other APIs H1 publishes across the network.

H1 Ribbon Providers API
H1 Ribbon Locations API
H1 Ribbon Custom Filters API
H1 Ribbon Focus Areas API
H1 Ribbon Price Transparency API
H1 Ribbon Organizations API
H1 Ribbon Reference Data API
H1 Ribbon Network Analysis API