Inbox Health API
Explore
Inbox Health Partner API v2
[ Base URL: api.demo.inboxhealth.com ]
Authorize
users Operations about users
DELETE/partner/v2/users/{id}
patients Operations about patients
PATCH/partner/v2/patients/contact_info
PUT/partner/v2/patients/{id}
DELETE/partner/v2/patients/{id}
GET/partner/v2/patients/{id}
GET/partner/v2/patients/{id}/statement_token
GET/partner/v2/patients/{id}/statement
PUT/partner/v2/patients/{id}/merge
GET/partner/v2/patients/{id}/patient_payment_infos
GET/partner/v2/patients/{id}/notifications
GET/partner/v2/patients/{id}/payments
GET/partner/v2/patients/{id}/invoices
payments Operations about payments
PUT/partner/v2/payments/{id}
GET/partner/v2/payments/{id}
POST/partner/v2/payments/quick_pay
GET/partner/v2/payments/{id}/invoice_payments
GET/partner/v2/payments/{id}/invoices
GET/partner/v2/payments/{id}/payment_adjustments
GET/partner/v2/payments/{id}/patient
invoices Operations about invoices
PUT/partner/v2/invoices/{id}
DELETE/partner/v2/invoices/{id}
GET/partner/v2/invoices/{id}
GET/partner/v2/invoices/{id}/notifications
GET/partner/v2/invoices/{id}/invoice_payments
GET/partner/v2/invoices/{id}/payments
GET/partner/v2/invoices/{id}/line_items
line_items Operations about line_items
PUT/partner/v2/line_items/{id}
DELETE/partner/v2/line_items/{id}
GET/partner/v2/line_items/{id}
account_managers Operations about account_managers
DELETE/partner/v2/account_managers/{id}
GET/partner/v2/account_managers/{id}
PUT/partner/v2/account_managers/{id}
GET/partner/v2/account_managers
POST/partner/v2/account_managers
events Operations about events
GET/partner/v2/events/{id}
POST/partner/v2/events/test_webhook
GET/partner/v2/events/types
endpoints Operations about endpoints
DELETE/partner/v2/endpoints/{id}
PUT/partner/v2/endpoints/{id}
GET/partner/v2/endpoints/{id}
enterprises Operations about enterprises
POST/partner/v2/enterprises
PUT/partner/v2/enterprises/{id}
GET/partner/v2/enterprises/{id}
DELETE/partner/v2/enterprises/{id}/logo
POST/partner/v2/enterprises/{id}/logo
GET/partner/v2/enterprises/{id}/logo
GET/partner/v2/enterprises/{id}/saved_line_items
GET/partner/v2/enterprises/{id}/account_types
GET/partner/v2/enterprises/{id}/deposit_accounts
GET/partner/v2/enterprises/{id}/write_off_codes
GET/partner/v2/enterprises/{id}/billing_cycle_templates
GET/partner/v2/enterprises/{id}/payment_reasons
GET/partner/v2/enterprises/{id}/admin_organizations
GET/partner/v2/enterprises/{id}/transfers
GET/partner/v2/enterprises/{id}/enterprise_payments
GET/partner/v2/enterprises/{id}/enterprise_payment_infos
GET/partner/v2/enterprises/{id}/enterprise_invoices
GET/partner/v2/enterprises/{id}/appointment_templates
GET/partner/v2/enterprises/{id}/patients
GET/partner/v2/enterprises/{id}/doctors
GET/partner/v2/enterprises/{id}/practices
appointments Operations about appointments
PUT/partner/v2/appointments/{id}
GET/partner/v2/appointments/{id}
GET/partner/v2/appointments
POST/partner/v2/appointments
GET/partner/v2/appointments/{id}/notifications
practices Operations about practices
GET/partner/v2/practices/{id}/doctors
GET/partner/v2/practices/{id}/users
GET/partner/v2/practices/{id}/practice_users
GET/partner/v2/practices/{id}/invoices
GET/partner/v2/practices/{id}
DELETE/partner/v2/practices/{id}
PUT/partner/v2/practices/{id}
doctors Operations about doctors
PUT/partner/v2/doctors/{id}
DELETE/partner/v2/doctors/{id}
GET/partner/v2/doctors/{id}
GET/partner/v2/doctors/{id}/shifts
GET/partner/v2/doctors/{id}/invoices
GET/partner/v2/doctors/{id}/practices
payers Operations about payers
partner_organizations Operations about partner_organizations
GET/partner/v2/partner_organizations/{id}
patient_encounters Operations about patient_encounters
POST/partner/v2/patient_encounters
PUT/partner/v2/patient_encounters/bulk_update
GET/partner/v2/patient_encounters/{encounter_id}
DELETE/partner/v2/patient_encounters/{encounter_id}
PUT/partner/v2/patient_encounters/{encounter_id}
patient_plans Operations about patient_plans
PUT/partner/v2/patient_plans/{id}
DELETE/partner/v2/patient_plans/{id}
GET/partner/v2/patient_plans/{id}
POST/partner/v2/patient_plans
PUT/partner/v2/patient_plans/{id}/reactivate
GET/partner/v2/patient_plans/{id}/eligibility_responses
PUT/partner/v2/patient_plans/{id}/verify
attachments Operations about attachments
POST/partner/v2/attachments
GET/partner/v2/attachments/{id}/view
GET/partner/v2/attachments/{id}/download
DELETE/partner/v2/attachments/{id}
PUT/partner/v2/attachments/{id}
GET/partner/v2/attachments/{id}
POST/partner/v2/attachments/{id}/fileupload
referring_doctors Operations about referring_doctors
PUT/partner/v2/referring_doctors/{id}
DELETE/partner/v2/referring_doctors/{id}
GET/partner/v2/referring_doctors/{id}
POST/partner/v2/referring_doctors
GET/partner/v2/referring_doctors
GET/partner/v2/referring_doctors/{id}/invoices
imported_payers Operations about imported_payers
PUT/partner/v2/imported_payers/{id}
GET/partner/v2/imported_payers/{id}
POST/partner/v2/imported_payers
GET/partner/v2/imported_payers
write_offs Operations about write_offs
GET/partner/v2/write_offs/{id}/line_items
GET/partner/v2/write_offs/{id}
write_off_codes Operations about write_off_codes
PUT/partner/v2/write_off_codes/{id}
GET/partner/v2/write_off_codes/{id}
POST/partner/v2/write_off_codes
GET/partner/v2/write_off_codes
admin_organizations Operations about admin_organizations
PUT/partner/v2/admin_organizations/{id}
GET/partner/v2/admin_organizations/{id}
POST/partner/v2/admin_organizations
GET/partner/v2/admin_organizations
GET/partner/v2/admin_organizations/{id}/users
GET/partner/v2/admin_organizations/{id}/enterprises
payment_reasons Operations about payment_reasons
PUT/partner/v2/payment_reasons/{id}
GET/partner/v2/payment_reasons/{id}
POST/partner/v2/payment_reasons
GET/partner/v2/payment_reasons
GET/partner/v2/payment_reasons/{id}/payment_reasons_invoice_payments
tickets Operations about tickets
GET/partner/v2/tickets/{id}
changelogs Operations about changelogs
GET/partner/v2/changelogs/types
invoice_payments Operations about invoice_payments
GET/partner/v2/invoice_payments/{id}
PUT/partner/v2/invoice_payments/{id}
POST/partner/v2/invoice_payments
account_types Operations about account_types
DELETE/partner/v2/account_types/{id}
PUT/partner/v2/account_types/{id}
GET/partner/v2/account_types/{id}
POST/partner/v2/account_types
GET/partner/v2/account_types
saved_line_items Operations about saved_line_items
DELETE/partner/v2/saved_line_items/{id}
PUT/partner/v2/saved_line_items/{id}
GET/partner/v2/saved_line_items/{id}
POST/partner/v2/saved_line_items
GET/partner/v2/saved_line_items
sftp_uploads Operations about sftp_uploads
POST/partner/v2/sftp_uploads/create_import_batch
GET/partner/v2/sftp_uploads
intents Operations about intents
PUT/partner/v2/intents/{id}/cancel
GET/partner/v2/intents/{id}
charge_categories Operations about charge_categories
GET/partner/v2/charge_categories
GET/partner/v2/charge_categories/{id}
notifications Operations about notifications
GET/partner/v2/notifications/{id}
GET/partner/v2/notifications/sent_emails/{id}
GET/partner/v2/notifications/sent_sms/{id}
GET/partner/v2/notifications/sent_calls/{id}
GET/partner/v2/notifications/sent_paper_bills/{id}
GET/partner/v2/notifications/sent/{id}
Get all sent notifications
Parameters
Try it out
| Name | Description |
|---|---|
| id * string (path) |
ID of the patient to get sent notifications for |
| sort string (query) |
Which model attribute to sort the results by |
| q string (query) |
String to search records by |
| do_nulls_last boolean (query) |
The nulls last query is a slow one, only want to fire it when explicitly wanted --truefalse |
| workspace_enterprise_ids array[integer] (formData) |
Array of Enterprise IDs to filter results on |
| cbo boolean (query) |
DANGER: Request OptimizerHints check Default value : false --truefalse |
| page integer($int32) (query) |
Page number to retrieve, default 10 results per page |
| per_page integer($int32) (query) |
How many results per page to return |
| get_total_pages_and_count boolean (query) |
Do get total pages and count for request --truefalse |
Responses
Response content type application/json
| Code | Description |
|---|---|
| 200 | Get all sent notifications |
GET/partner/v2/notifications
GET/partner/v2/notifications/{id}/notification_logs
import_jobs Operations about import_jobs
POST/partner/v2/import_jobs/import_jobs_for_import_batch
import_batches Operations about import_batches
POST/partner/v2/import_batches
GET/partner/v2/import_batches
POST/partner/v2/import_batches/{id}
payment_adjustments Operations about payment_adjustments
GET/partner/v2/payment_adjustments/{id}
POST/partner/v2/payment_adjustments
setup_intents Operations about setup_intents
POST/partner/v2/setup_intents/finalize_setup
PUT/partner/v2/setup_intents/{id}
GET/partner/v2/setup_intents/{id}
POST/partner/v2/setup_intents
Models
putPartnerV2PatientsId
PatientEntity
PatientPlanEntity
EligibilityResponseEntity
EmergencyContactEntity
ExternalIdEntity
postPartnerV2Patients
GetPatientsEntity
MetaEntity
GetPatientPaymentInfosEntity
PatientPaymentInfoEntity
GetNotificationsEntity
NotificationEntity
GetPaymentsEntity
PaymentEntity
AdditionalFeeEntity
GetInvoicesEntity
InvoiceEntity
LineItemEntity
AccountTypeEntity
putPartnerV2PaymentsId
postPartnerV2PaymentsQuickPay
QuickPayEntity
postPartnerV2Payments
GetInvoicePaymentsEntity
InvoicePaymentEntity
PaymentReasonsInvoicePaymentEntity
PaymentReasonEntity
GetPaymentAdjustmentsEntity
PaymentAdjustmentEntity
putPartnerV2InvoicesId
postPartnerV2Invoices
GetLineItemsEntity
postPartnerV2Enterprises
EnterpriseEntity
PracticeEntity
EnterprisePlanEntity
putPartnerV2EnterprisesId
GetEnterprisesEntity
SavedLineItemEntity
GetDepositAccountsEntity
DepositAccountEntity
GetWriteOffCodesEntity
WriteOffCodeEntity
GetBillingCycleTemplatesEntity
BillingCycleTemplateEntity
GetPaymentReasonsEntity
GetAdminOrganizationsEntity
AdminOrganizationEntity
IntegrationCredentialEntity
GetTransfersEntity
TransferEntity
GetEnterprisePaymentsEntity
EnterprisePaymentEntity
GetEnterprisePaymentInfosEntity
EnterprisePaymentInfoEntity
GetEnterpriseInvoicesEntity
EnterpriseInvoiceEntity
AppointmentTemplateEntity
GetDoctorsEntity
DoctorEntity
GetPracticesEntity
putPartnerV2DoctorsId
postPartnerV2Doctors
GetShiftsEntity
ShiftEntity