---
title: "List pages"
method: GET
path: "/api/v1/pages"
tags: ["Page"]
---

# List pages

`GET /api/v1/pages`

Retrieve all page objects.

## Query parameters

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

## Response `200`

Returns paginated response with a list of page objects.

- object
  - `pagination` Pagination, required
    - `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.
  - `results` PageObject[], required
    - `id` integer, required — ID of the page
    - `url` string, uri, required — URL of the page.
    - `annotation` string, uri, required — Annotation that page belongs to.
    - `number` integer, required — Page index, first page has index 1.
    - `rotation_deg` integer, required — Page rotation.
    - `mime_type` string, required — MIME type of the page (`image/png`).
    - `s3_name` string, required — Storage key of the page file. Internal use only.
    - `content` string, uri, required — Link to the page raw content (e.g. pdf file).
    - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
    - `width` integer, nullable, required — Page width in pixels (for internal purposes only)
    - `height` integer, nullable, required — Page height in pixels (for internal purposes only)

## 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)