View insurance plans

get

https://nexhealth.info/insurance_plans

This endpoint returns a list of insurance plans. All filters are optional: without any filters, every insurance plan for the institution is returned. You can narrow the results by payer_id, group_num or updated_since. Soft-deleted plans are excluded unless include_deleted is true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

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 at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned

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

Filter for plans with the specified group number

include_deleted

boolean

Defaults to false

Include soft-deleted insurance plans in the results

Headers

Nex-Api-Version

string

required

Defaults to v3.0.0

The NexHealth API version

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error