---
title: "Get List of Workpapers"
method: POST
path: "/api/audit-management/v1/audit-workpapers/pages"
tags: ["Workpapers"]
---

# Get List of Workpapers

`POST /api/audit-management/v1/audit-workpapers/pages`

Use this API to retrieve a list of all workpapers by key terms and filters. The response will include details for each workpaper along with the associated audit, findings, and attributes.

## Query parameters

- `page` integer
- `size` integer
- `sort` 'number,asc' | 'number,desc' | 'name,asc' | 'name,desc'

## Request body

- SearchCriteriaRequest — unresolved $ref

## Response `200`

OK

- PageWorkPaperListInformation
  - `content` WorkpaperListInformation[] — The list of items for the current page
    - `workpaperId` string, uuid — Workpaper identifier
    - `number` integer — Workpaper Number
    - `auditId` string, uuid — Audit Identifier
    - `auditName` string — Audit Name
    - `scopeId` string, uuid — Scope ID
    - `orgGroup` BasicEntityDetail
      - `id` string, uuid — The unique identifier of the entity.
      - `name` string — The name of the entity.
    - `entityType` 'CONTROL' | 'CONTROL_IMPLEMENTATION' — Scope entity type
    - `entityDetail` BasicEntityDetail
      - `id` string, uuid — The unique identifier of the entity.
      - `name` string — The name of the entity.
    - `auditors` BasicEntityDetail[] — Auditor Names
      - `id` string, uuid — The unique identifier of the entity.
      - `name` string — The name of the entity.
    - `approvers` BasicEntityDetail[] — Approver Names
      - `id` string, uuid — The unique identifier of the entity.
      - `name` string — The name of the entity.
    - `stage` StageInformation
      - `id` string, uuid, required — ID of the entity
      - `name` string — Name of the Entity
      - `nameKey` string — Namekey of the entity for localization
      - `badgeColor` string — Workflow Stage Badge Color
    - `workflow` BasicEntityDetailTranslation
      - `id` string, uuid, required — ID of the entity
      - `name` string — Name of the Entity
      - `nameKey` string — Namekey of the entity for localization
    - `countOfFindings` integer — Count of findings for Workpaer
    - `attributes` object — Custom Attributes
  - `empty` boolean — The flag to check if the entity is empty or not.
  - `first` boolean — The flag to check if the entity is first entity or not.
  - `last` boolean — The flag to check if the entity is last entity or not.
  - `number` integer — The number associated with the result.
  - `numberOfElements` integer — Total number of elements in the result.
  - `pageable` Pageable
    - `offset` integer — The offset of the list.
    - `pageNumber` integer — Page number of the results list (0….N).
    - `pageSize` integer — Number of records per page (0…N).
    - `paged` boolean — The flag to determine if the list is paged. If set True, the list is paged.
    - `sort` Sort
      - `empty` boolean — The flag to determine if the list is empty.
      - `sorted` boolean — The flag to determine if the list is sorted. If set True, the list is sorted.
      - `unsorted` boolean — The flag to determine if the list is unsorted. If set True, the list is unsorted.
    - `unpaged` boolean — The flag to determine if the list is not paged. If set True, the list is not paged.
  - `sort` Sort
    - `empty` boolean — The flag to determine if the list is empty.
    - `sorted` boolean — The flag to determine if the list is sorted. If set True, the list is sorted.
    - `unsorted` boolean — The flag to determine if the list is unsorted. If set True, the list is unsorted.
  - `totalPages` integer — Total number of pages in the result list.
  - `totalElements` integer — Total number of elements in the result.
  - `size` integer — Size of the result list.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)