---
title: "View claims"
method: GET
path: "/claims"
tags: ["Claims"]
---

# View claims

`GET /claims`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/claims`
- Auth: API key in header `Authorization`

This endpoint returns a list of insurance claims for a location. You can filter by patient_id, guarantor_id, provider_id, updated_since or date_of_service, and must provide at least one of these filters. location_id is always required, but does not satisfy the at-least-one-filter requirement on its own. Soft-deleted claims are excluded unless include_deleted is true.

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `sort` string
- `patient_id` integer
- `guarantor_id` integer
- `provider_id` integer
- `updated_since` string, date-time
- `date_of_service` string, date
- `include_deleted` boolean
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesLedgerInsuranceClaimBasicWithDeleteCollectionResponseWithCursor: API_V20240412_Entities_Ledger_Insurance_ClaimBasicWithDelete_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` APIV20240412EntitiesLedgerInsuranceClaimBasicWithDelete[]
    - `id` integer: Claim id
    - `location_id` integer, nullable: Location id. Null when the claim is not attached to a location
    - `patient_id` integer, nullable: Patient id. Null when the claim is not attached to a patient
    - `provider_id` integer, nullable: Provider id. Null when the claim is not attached to a provider
    - `guarantor_id` integer, nullable: User id of the patient's responsible party. Null when the claim is not attached to a guarantor
    - `status` 'draft' | 'sent' | 'received' | 'canceled', nullable: Claim status
    - `received_at` string, date-time, nullable: Date and time in UTC when the claim was received from insurance
    - `sent_at` string, date-time, nullable: Date and time in UTC when the claim was sent to insurance
    - `note` string, nullable: Claim notes
    - `primary_insurance_plan_id` integer, nullable: Id of the primary insurance plan this claim was or will be sent to
    - `secondary_insurance_plan_id` integer, nullable: Id of the secondary insurance plan this claim was or will be sent to
    - `date_of_service` string, date, nullable: The date in UTC when the procedures included in the claim occurred
    - `totals` APIV20240412EntitiesLedgerChargeClaimTotals
      - `amount_billed_to_insurance` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `estimated_insurance_payment` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `insurance_payment` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `write_off` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
    - `updated_at` string, date-time: Claim update date in UTC
    - `deleted_at` string, date-time, nullable: The UTC date and time the claim was deleted. Null when the claim is not deleted. Deleted claims are only listed 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.dev/nexhealth/apis/nexhealth-api.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api/revisions/a180e830b672?raw)