latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

insurancePayors

Search insurance payors

Searches the account's insurance payor directory. Patients (and callers with the widget role) receive a filtered, patient-friendly view that excludes payors marked isHiddenFromPatients and prefers friendlyName.

get/insurancePayors

Query parameters

querystring

Free-text search against name and external identifiers. If this is a 24-character hex string, it is treated as an _id lookup instead.

hasTransactionIdboolean

Filter to payors that do (or don't) have at least one external identifier value set.

isHiddenFromPatientsboolean
status'inactive' | 'testing' | 'live'

Filter by the status of the payor's external identifiers.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

pageinteger
limitinteger

How many items to fetch per page

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

Response

List of insurance payors

pageinteger required
sizeinteger required