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

Hint Health Membership API

The Membership API from Hint Health — 6 operation(s) for membership.

Hint Health Membership API is one of 49 APIs that Hint Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 9 operations across 6 paths, and defines 23 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.hint.com/api, https://api.sandbox.hint.com/api.

9 operations 6 paths 23 schemas 1 DELETE3 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.hint.com
Authentication
HTTP Bearer
License
Private
Terms of Service
Resource Areas
1

Authentication & Security 1

Hint Health Membership API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Practice access token or Partner API key (Bearer authentication)

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Membership 9
POST
/provider/memberships/{id}/bill
Bill Membership
Membership.BillMembership 1 param body → 200
POST
/provider/memberships/{id}/cancel
Cancel Membership
Membership.CancelMembership 1 param body → 200
POST
/provider/memberships/{id}/confirm
Confirm Membership
Membership.ConfirmMembership 1 param → 200
POST
/provider/memberships
Create Membership
Membership.CreateMembership body → 200
GET
/provider/memberships
List All Memberships
Membership.ListAllMemberships 2 params → 200
DELETE
/provider/memberships/{id}
Delete Membership
Membership.DeleteMembership 1 param → 204
GET
/provider/memberships/{id}
Show Membership
Membership.ShowMembership 1 param → 200
PATCH
/provider/memberships/{id}
Update Membership
Membership.UpdateMembership 1 param body → 200
GET
/provider/memberships/new
New Membership
Membership.NewMembership 1 param → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Public.PatientBlueprint_leaf (54 properties), Public.MembershipBlueprint_one (33 properties), Public.MembershipBillBlueprint_shared_with_invoice (14 properties), Public.CouponBlueprint_one (13 properties). Each schema is shown below with its type and property counts.

Public.CompanyAccountBlueprint_for_membership_one
object
2 properties
Public.CompanySponsorshipBlueprint_for_patient
object
6 properties
Public.PatientBlueprint_min
object
2 properties
Public.MembershipPatientBlueprint_for_membership_one
object
10 properties
Public.MembershipBillBlueprint_shared_with_invoice
object
14 properties
Public.Payable.InvoiceBlueprint_for_membership_bill
object
8 properties
Public.CouponBlueprint_one
object
13 properties
Public.CompanyAccountBlueprint_min
object
1 property
MembershipUpdateSanitizer.Patient
object
2 properties 1 required
Provider.MembershipsController.bill_body
object
1 property 1 required
Public.PhoneBlueprint_leaf
object
2 properties
Public.MembershipPatientBlueprint_leaf_with_patient
object
8 properties
Public.CompanyBlueprint_leaf
object
2 properties
Association
object
1 property 1 required
Public.MembershipBlueprint_all
array
Provider.MembershipsController.cancel_body
object
3 properties 2 required
Public.PatientBlueprint_leaf
object
54 properties
Public.LeadSourceBlueprint_one
object
4 properties
MembershipCreateSanitizer
object
9 properties 4 required
Public.MembershipBlueprint_one
object
33 properties
MembershipUpdateSanitizer
object
8 properties 4 required
Public.PlanBlueprint_min
object
3 properties
MembershipUpdateSanitizer.MembershipPatient
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hint-health-membership-api-openapi.yml Raw ↑

Other APIs Hint Health publishes across the network.

Hint Health AccountAccessToken API
Hint Health Affiliate API
Hint Health AffiliateBill API
Hint Health AffiliatePatient API
Hint Health CancellationReason API
Hint Health Charge API
Hint Health ChargeItem API
Hint Health ClinicalNoteInteraction API
Hint Health Company API
Hint Health CompanyPlan API
Hint Health Coupon API
Hint Health Credit API