View insurance plans (beta)

get

https://nexhealth.info/insurance_plans

🚧
Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query param location_id; adds response fields data[].annual_max_individual, data[].annual_max_individual.amount, data[].annual_max_individual.currency, data[].benefit_year_renewal_month (+19 more).

This endpoint returns insurance plans for the specified location, optionally filtered by payer_id, group_num, or updated_since.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

sort

string

Optional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields:

updated_at
-updated_at

updated_since

date-time

Insurance plans updated after the specified time (UTC)

payer_id

string

A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically

group_num

string

Group number

include_deleted

boolean

Defaults to false

Include deleted insurance plans

Headers

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error