---
title: "List suggested edits"
method: GET
path: "/api/v1/suggested_edits"
tags: ["Suggested Edit"]
---

# List suggested edits

`GET /api/v1/suggested_edits`

Retrieve all suggested edit objects.

## Query parameters

- `page_size` integer
- `cursor` string
- `id` integer[]
- `annotation` integer[]
- `ordering` 'annotation' | '-annotation'

## Response `200`

OK

- object
  - `results` SuggestedEdit[]
    - `id` integer, required — ID of the suggested edit.
    - `url` string, url, required — URL of the suggested edit.
    - `annotation` string, url, required — Annotation that suggested edit is related to.
    - `documents` DocumentSplitDescriptor[], required — List of document split descriptors.
      - `pages` PageDescriptor[] — List of pages that should be split.
        - `page` string, url — Page to split.
        - `rotation` integer — Rotation of the page.
        - `deleted` boolean — Indicates whether the page is marked as deleted.
      - `target_queue` string, url — Target queue for the suggested split.
      - `values` object — Edit values to be propagated to newly created annotations. Keys must be prefixed with "edit:", e.g. "edit:document_type". Schema Datapoint description describes how it is used to initialize datapoint value.
  - `pagination` Pagination
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)