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 Company API

The Company API from Hint Health — 3 operation(s) for company.

Hint Health Company 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 Company. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 13 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.

5 operations 3 paths 13 schemas 2 GET1 PATCH2 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 Company 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 5

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

Company 5
POST
/provider/companies
Create Company
Company.CreateCompany body → 200
GET
/provider/companies
List All Companies
Company.ListAllCompanies → 200
POST
/provider/companies/{id}/deactivate
Deactivate Company
Company.DeactivateCompany 1 param → 200
GET
/provider/companies/{id}
Show Company
Company.ShowCompany 1 param → 200
PATCH
/provider/companies/{id}
Update Company
Company.UpdateCompany 1 param body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Public.CompanyBlueprint_one (10 properties), Public.AddressBlueprint_leaf (9 properties), Address (6 properties), CompanyCreateSanitizer (4 properties). Each schema is shown below with its type and property counts.

Public.PractitionerBlueprint_min
object
2 properties
PhoneNumber
object
4 properties 2 required
Public.PhoneBlueprint_leaf
object
2 properties
Public.CompanyBlueprint_all
array
CompanyUpdateSanitizer
object
3 properties
Association
object
1 property 1 required
Address
object
6 properties 4 required
CompanyCreateSanitizer
object
4 properties
Public.EmployeeDivisionBlueprint_leaf
object
2 properties
Public.LocationBlueprint_min
object
2 properties
Public.PlanBlueprint_min
object
3 properties
Public.AddressBlueprint_leaf
object
9 properties
Public.CompanyBlueprint_one
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hint-health-company-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 CompanyPlan API
Hint Health Coupon API
Hint Health Credit API
Hint Health CreditCategory API