---
title: "Search insurance payors"
method: GET
path: "/insurancePayors"
tags: ["insurancePayors"]
---

# Search insurance payors

`GET /insurancePayors`

Searches the account's insurance payor directory. Patients (and callers with the `widget` role) receive a filtered, patient-friendly view that excludes payors marked `isHiddenFromPatients` and prefers `friendlyName`.

## Query parameters

- `query` string
- `hasTransactionId` boolean
- `isHiddenFromPatients` boolean
- `status` 'inactive' | 'testing' | 'live'
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

List of insurance payors

- object
  - `response` InsurancePayorResponse[], required
    - `_id` string — Luma's internal ID of an object.
    - `user` string — The ID of the root account user.
    - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
    - `createdBy` string — The ID of the user who created this object.
    - `updatedBy` string — The ID of the user who updated this object.
    - `createdAt` string, date-time — The date/time when this object was created.
    - `updatedAt` string, date-time — The date/time when this object was updated.
    - `name` string — The payor's legal/system name.
    - `friendlyName` string — Patient-facing display name, preferred over `name` when present.
    - `externalId` object — The payor's identifier in the practice's EHR.
      - `source` string
      - `value` string
    - `externalIdentifiers` object[] — Identifiers used to match and write back claims and eligibility data to third-party clearinghouses, such as NextGen Transaction Hub, Change Healthcare, or Waystar.
      - `source` 'nextgentransactionhub' | 'changehealthcare' | 'waystar' — The clearinghouse or vendor this identifier is for.
      - `value` string — The opaque identifier value used by that vendor.
      - `status` 'inactive' | 'testing' | 'live'
      - `pin` string — Waystar-specific identifier for this payor.
    - `address` string
    - `address2` string
    - `city` string
    - `state` string
    - `country` string
    - `postcode` string
    - `phone` string
    - `source` 'integrator' | 'manual' — Who owns this payor's fields. If `integrator`, the integrator owns all fields and overwrites Luma edits on every sync. If `manual`, the integrator only owns `name` and `externalId`; `friendlyName` and `externalIdentifiers` can be freely edited in Luma.
    - `isHiddenFromPatients` boolean — Whether this payor is excluded from patient-facing payor search.
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope

---

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