Skip to main content
GET
Search payers

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

q
string

Search payer names, electronic codes or an exact source payer UUID. Name words match case-insensitively across punctuation.

Maximum string length: 200
cursor
string

Last source payer UUID from the preceding page. Keep the query unchanged while paging.

instanceId
string

Only payers in this EHR instance: an instanceId from GET /payers/capabilities or from a patient. An id that matches no instance returns an empty list. Cannot be combined with patientId or newChart=true.

patientId
string

Only payers in this patient's EHR instance, the only payers POST /patients/{id}/insurance:exact can accept for the chart. Requires read:patients. 404 patient_not_found when the patient is not in this organization. Cannot be combined with instanceId or newChart=true.

newChart
boolean

true lists the payers of the EHR instance POST /patients would create a chart in, given the same primaryFacilityId. 400 for a facility outside this organization; 503 no_booking_identity when no live system connector can create the chart. false is the same as omitting it. Cannot be combined with instanceId or patientId.

primaryFacilityId
string

The primaryFacilityId you will send to POST /patients; omit it if the create will omit it. A facility UUID from GET /facilities (fac_… also accepted on v3+). Only with newChart=true.

limit
number
default:25
Required range: 1 <= x <= 100

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required