---
title: "Show a list of estimate"
method: GET
path: "/estimates"
tags: ["estimates"]
---

# Show a list of estimate

`GET /estimates`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/estimates`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/estimates/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `date` unknown
- `totalPatientAmountInCents` number
- `readAt` unknown
- `payCode` object
  - `source` 'change-healthcare'
  - `value` string
- `patient` string
- `appointment` string
- `fileUpload` string
- `message` string
- `visible` string
- `source` 'change-healthcare'
- `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`

Returns a list of estimates

- object
  - `response` EstimateResponse[], 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.
    - `date` string, date-time: The date of service.
    - `totalPatientAmountInCents` number: The total amount for the patient.
    - `readAt` string, date-time: The time that the estimate was read.
    - `payCode` object: The paycode from estimate.
      - `source` 'change-healthcare'
      - `value` string
    - `patient` string: ID of a patient.
    - `appointment` string: ID of an appointment.
    - `fileUpload` string: ID of a file upload.
    - `message` string: ID of a message.
    - `visible` boolean: Flag that indicates if estimate is visible or not to the patient.
    - `source` 'change-healthcare'
    - `searchIds` string[]: Search ID index.
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope
- `default`: unexpected error

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)