Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Insurance

View 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.

get/insurance_plans

Query parameters

subdomainstring required

Used to scope the request to the specified institution

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

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

sortstring

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

Available fields:

  • updated_at
  • -updated_at
updated_sincestring 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_idstring

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

group_numstring

Filter for plans with the specified group number

include_deletedboolean

Include soft-deleted insurance plans in the results

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 18,
      "payer_id": "87726",
      "name": "United Healthcare",
      "address": "123 Law St",
      "address2": "85335, North East",
      "city": "New York",
      "state": "NY",
      "zip_code": "54700",
      "country_code": "US",
      "group_num": "12345",
      "employer_name": "Walmart",
      "foreign_id": "1",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "deleted_at": "2024-09-15T11:21:26.003Z"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}