Sign in

v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Insurance Companies

Retrieve Insurance Company

get/api/2.0/insurance_companies/{id}/

Path parameters

idinteger required

Response

addressstring
aliasesstring nullable

A string used to create alternate terms that will come up in search results (for example "BC" for Blue Cross).

carrierstring required
citystring
created_datestring date-time nullable
deleted_datestring date-time nullable
eligibility_payer_idstring nullable
extensionstring nullable
external_vendor_idstring nullable

The ID used by a vendor to represent the carrier in their system.

idinteger
is_credentialedboolean nullable

Whether or not the practice has credentials to submit claims to the carrier.

is_enrolledboolean nullable
patientsinteger[]
payer_idstring nullable

The Payer ID of the insurance carrier.

phonestring nullable
plansinteger[]
practiceinteger required
statestring
suitestring nullable
zipstring