---
title: "List Claims"
method: POST
path: "/fetch/CL"
tags: ["Claims"]
---

# List Claims

`POST /fetch/CL`

Retrieves a list of Claims. A filter can be applied (for example, to retrieve a particular Claim with the specified name).

---

Required Permission| Roles with the Required Permission |
---------|----------|
 CLAIM_FETCH | Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage Claims (`CLM_CLAIMMANAGER`), Use Claims (`CLM_CLAIM`)

## Request body

- object
  - `endRow` number — The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
  - `oldValues` unknown
  - `operationType` string
  - `startRow` number — The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
  - `textMatchStyle` string

## Response `200`

OK

- object
  - `response` object
    - `node` string
    - `startRow` number
    - `data` Claim[]
      - `lastUpdateByName` string
      - `createdByName` string
      - `fileName` string, nullable
      - `typedId` string
      - `claimRecord` string, nullable
      - `workflowStatus` 'DRAFT' | 'SUBMITTED' | 'DENIED' | 'APPROVED' | 'NO_APPROVAL_REQUIRED' | 'WITHDRAWN' | 'INVALIDATED'
      - `lastUpdateDate` string, date-time
      - `submitDate` string, date-time, nullable
      - `locale` string, nullable
      - `calculationDate` string, date-time, nullable
      - `externalRef` string, nullable
      - `deniedByName` string, nullable
      - `claimType` string
      - `fileHandle` string, nullable
      - `sourceQuoteUniqueName` string, nullable
      - `customerId` string, nullable
      - `submittedByName` string, nullable
      - `approvedByName` string, nullable
      - `id` integer
      - `createDate` string, date-time
      - `sourceContractUniqueName` string, nullable
      - `calculationMessages` string, nullable
      - `approvalRequiredEmailAttachments` object[], nullable
      - `targetDate` string, date, nullable
      - `label` string
      - `version` integer
      - `customerName` string, nullable
      - `uniqueName` string
      - `createdBy` integer
      - `progress` string, nullable
      - `claimStatus` 'DRAFT' | 'APPROVED' | 'REVOKED'
      - `calculationStartDate` string, date-time, nullable
      - `lastUpdateBy` integer
      - `status` 'DRAFT' | 'PENDING' | 'SCHEDULED' | 'PROCESSING' | 'SCHEDULED_DIRTY' | 'ERROR' | 'READY' | 'CANCELLED'
    - `endRow` number
    - `totalRows` number
    - `status` number

---

[API](https://skmtc.net/pricefx/apis/the-pricefx-backend-api.md) · [All operations](https://skmtc.net/pricefx/apis/the-pricefx-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pricefx/the-pricefx-backend-api/versions/0850b5d6be73/schema)