ROrossum
Page

List pages

Changed on

Retrieve all page objects.

get/api/v1/pages

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Filter by a list of ids, e.g. ?id=1,2,3

annotationinteger[]

Filter by a list of annotation IDs

numberinteger[]

Filter by a list of page numbers, e.g. ?number=1,2

ordering'id' | '-id' | 'number' | '-number' | 's3_name' | '-s3_name'

Result ordering.

Response

Returns paginated response with a list of page objects.

Example response

{
  "results": [
    {
      "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

  • f1b5a910991dRevision 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