---
title: "View insurance plans"
method: GET
path: "/insurance_plans"
tags: ["Insurance"]
---

# View insurance plans

`GET /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.

## Query parameters

- `subdomain` string, required
- `start_cursor` string
- `end_cursor` string
- `per_page` integer
- `sort` string
- `updated_since` string, date-time
- `payer_id` string
- `group_num` string
- `include_deleted` boolean

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIEntitiesInsuranceEhrPlanCollectionResponseWithCursor — API_Entities_Insurance_EhrPlan_Collection_Response_WithCursor model
  - `code` boolean — Indicates the success or failure of the request
  - `description` string — Additional context on the request to help with debugging.
  - `error` string[] — Any errors that occur during the execution of the request.
  - `data` APIEntitiesInsuranceEhrPlan[]
    - `id` integer — Plan id
    - `payer_id` string, nullable — A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically
    - `name` string, nullable — Plan name
    - `address` string, nullable — Street address
    - `address2` string, nullable — Street address 2
    - `city` string, nullable — City
    - `state` string, nullable — 2 letter state code
    - `zip_code` string, nullable — Zip code
    - `country_code` string, nullable — 2 letter country code
    - `group_num` string, nullable — Group number
    - `employer_name` string, nullable — Employer name
    - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system
    - `updated_at` string, date-time — Insurance Plan update date in UTC
    - `deleted_at` string, date-time, nullable — The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true
  - `page_info` object — Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)