Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential2

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Page

Retrieve page

Changed on Sep 1, 2026

Get a page object.

get/api/v1/pages/{pageID}

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/pages/:pageID/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

pageIDinteger required

A unique integer value identifying this page.

Response

idinteger required

ID of the page

urlstring uri required

URL of the page.

annotationstring uri required

Annotation that page belongs to.

numberinteger required

Page index, first page has index 1.

rotation_deginteger required

Page rotation.

mime_typestring required

MIME type of the page (image/png).

s3_namestring required

Storage key of the page file. Internal use only.

contentstring uri required

Link to the page raw content (e.g. pdf file).

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

widthinteger nullable required

Page width in pixels (for internal purposes only)

heightinteger nullable required

Page height in pixels (for internal purposes only)

Example response

{
  "id": 558598,
  "url": "https://example.rossum.app/api/v1/pages/558598",
  "annotation": "https://example.rossum.app/api/v1/annotations/314528",
  "number": 1,
  "mime_type": "image/png",
  "s3_name": "7eb0dcc0faa8868b55fb425d21cc60dd",
  "content": "https://example.rossum.app/api/v1/pages/558598/content",
  "metadata": {
    "some_key": "some_value"
  }
}

Changes

Sep 1, 2026f1b5a910991d Revision changes
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status

Operation history