Skip to main content

Get document pages

GET 
/documents/:id/pages

Retrieve Document Pages.

This endpoint allows the authenticated user to retrieve the pages (images) associated with a specific document. The document ID must be provided to identify which document's pages to retrieve.

Authentication:​

  • Requires a valid OAuth access token with the following scopes:
    • document:read
    • Or one of the internal scopes: org:staff, org:admin, admin
    • Public scopes may also be included.

Parameters:​

  • id (required, path): The unique identifier (UUID) of the document for which the pages are to be retrieved.

Response:​

  • 200 OK: Returns a list of images representing the pages of the specified document.
  • 404 Not Found: If the document with the provided ID cannot be found.
  • 403 Forbidden: If the user does not have the necessary permissions to access the document pages.

Request​

Responses​

Successful Response