Hint Health Interaction API
The Interaction API from Hint Health — 1 operation(s) for interaction.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hint-health-interaction-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Hint Health Interaction API
license:
name: Private
termsOfService: https://www.hint.com/terms
x-refined-note:
- x-api-evangelist-harvest differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged Interaction across 2 of this provider''s published API definitions: hint-health-hint-health-api-openapi.yml, hint-health-partner-endpoints-2026-07-01-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
tags:
- name: Interaction
paths:
/provider/interactions:
get:
tags:
- Interaction
operationId: Interaction.ListAllInteractions
summary: List All Interactions
description: ''
parameters:
- name: patient_id
in: query
required: false
description: Allows filtering interactions by patient id.
schema:
type: array
items:
type: string
- name: status
in: query
required: false
description: ' Allows filtering interactions by status.'
schema:
type: array
items:
type: string
enum:
- draft
- signed
- addended
- deleted
- failed
- name: type
in: query
required: false
description: ' Allows filtering interactions by type.'
schema:
type: array
items:
type: string
enum:
- note
- phone_call
- email
- lab
- fax
- rx
- rx_veradigm
- rx_dosespot
- vitals
- document
- name: limit
in: query
required: false
description: Allows limiting the number of interactions returned.
schema:
type: integer
format: int32
- name: offset
in: query
required: false
description: Allows offsetting the number of interactions returned.
schema:
type: integer
format: int32
- name: created_at
in: query
required: false
description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information.
schema:
type: string
format: date-time
- name: updated_at
in: query
required: false
description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information.
schema:
type: string
format: date-time
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.InteractionBlueprint_all'
example:
- id: inter-ab12C345DeF6
body: This is a test body
patient_id: pat-123456
status: draft
title: 'Lab #123456'
type: partner
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
- id: inter-ab12C345DeF6
body: This is a test body
patient_id: pat-123456
status: draft
title: 'Lab #123456'
type: partner
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
- id: inter-ab12C345DeF6
body: This is a test body
patient_id: pat-123456
status: draft
title: 'Lab #123456'
type: partner
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
headers:
X-Count:
description: The number of resources returned in this request
schema:
type: integer
X-Total-Count:
description: The total number of resources available (scoped to query params)
schema:
type: integer
security:
- BearerAuth: []
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
/provider/interactions/{interaction_id}/files/download_urls:
get:
tags:
- Interaction
operationId: Interaction.ListInteractionFileDownloadUrls
summary: List Interaction File Download URLs
description: 'Returns a short-lived, single-use download URL for every file attached to
the interaction. Only PDFs are downloadable; other file types are listed
with a null url. The URLs cannot be saved and refetched later.'
parameters:
- name: interaction_id
in: path
required: true
description: Unique Interaction ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.Interaction.FileBlueprint_download_url'
example:
- id: Fah-3TWDJuQ1MSe-lBTiPh
expires_at: '2026-07-01T12:05:00.000Z'
filename: lab-results.pdf
url: https://practice-bucket.s3.amazonaws.com/public/pat-123456/lab-results.pdf?X-Amz-Signature=EXAMPLE
- id: Znd8CviNr5RERx6L-v5auf
expires_at: null
filename: scan.tiff
url: null
servers:
- url: https://api.sandbox.hint.com/api
/provider/interactions/{interaction_id}/files/{id}/download_url:
get:
tags:
- Interaction
operationId: Interaction.GetInteractionFileDownloadUrl
summary: Get Interaction File Download URL
description: 'Returns a short-lived, single-use download URL for one file on the
interaction, addressed by its id. Responds 404 when the id does not match
a file on the interaction, and 422 when the file is not a PDF.'
parameters:
- name: interaction_id
in: path
required: true
description: Unique Interaction ID
schema:
type: string
- name: id
in: path
required: true
description: Unique Interaction ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.Interaction.FileBlueprint_download_url'
example:
id: Fah-3TWDJuQ1MSe-lBTiPh
expires_at: '2026-07-01T12:05:00.000Z'
filename: lab-results.pdf
url: https://practice-bucket.s3.amazonaws.com/public/pat-123456/lab-results.pdf?X-Amz-Signature=EXAMPLE
servers:
- url: https://api.sandbox.hint.com/api
components:
schemas:
Public.InteractionBlueprint_all:
type: array
items:
type: object
properties:
id:
type: string
body:
type: string
patient_id:
type: string
status:
type: string
title:
type: string
type:
type: string
Public.Interaction.FileBlueprint_leaf:
type: object
properties:
id:
type: string
filename:
type: string
Public.Interaction.FileBlueprint_download_url:
type: object
properties:
id:
type: string
expires_at:
type: string
filename:
type: string
url:
type: string
Public.InteractionBlueprint_all_2:
type: array
items:
type: object
properties:
id:
type: string
body:
type: string
event_timestamp:
type: string
format: date-time
patient_access:
type: boolean
patient_id:
type: string
status:
type: string
title:
type: string
type:
type: string
files:
type: array
items:
$ref: '#/components/schemas/Public.Interaction.FileBlueprint_leaf'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Practice access token or Partner API key (Bearer authentication)
hint_api_key:
type: apiKey
name: AUTHORIZATION
in: header
description: 'Enter your token in the format: `Bearer {your_api_key}`'
x-refined-from:
- hint-health-hint-health-api-openapi.yml
- hint-health-partner-endpoints-2026-07-01-openapi.yml