---
title: "List cancellations"
method: GET
path: "/cancellations/"
tags: ["Procurement"]
---

# List cancellations

`GET /cancellations/`

## Query parameters

- `page` integer
- `page_size` integer
- `retention` integer

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated cancellation list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Cancellation[], required — The items in the current page.
    - `id` integer
    - `retention` integer, required — Retention ID being cancelled.
    - `document` integer, required — Cancellation document type.
    - `number` integer, required
    - `date` string, date, required
    - `note` string, nullable
    - `internal_note` string, nullable
    - `biller_status` string
    - `tax_agency` object
    - `local_file` string, uri, nullable
    - `imported` boolean
    - `test_mode` boolean
    - `created` string, date-time
    - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/versions/70cbc827dc7b/schema)