> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sterndesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ListDocumentPages

> list document pages



## OpenAPI

````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.OrganizationService/ListDocumentPages
openapi: 3.1.0
info:
  title: Sterndesk API
  version: 1.0.0
  description: >
    HTTP/JSON access to the Sterndesk data available to your account.


    Every Sterndesk operation is a Connect RPC: send `POST <path>` with a JSON
    body and the

    `Connect-Protocol-Version: 1` header. Authenticate with a personal API key

    (Settings → My account → API keys) using `Authorization: Bearer <key>`.


    A key reads everything documented here. The one write operation is uploading
    candidate

    documents, which needs a key carrying the `sterndesk:documents:write`
    permission; permissions

    are chosen when the key is created and are never added to an existing key.
    Every other write

    operation is rejected.


    ## Uploading candidate documents


    An upload is a batch of documents, the same batch a recruiter hands to
    Sterndesk from the

    dashboard. It may hold the documents of one candidate or of several people:
    Sterndesk groups

    them by identity and creates one candidate per person. Sending them takes
    two calls.


    1. `POST /rpc/rpc.v1.OrganizationService/CreateManualUpload` creates the
    upload and returns a
       signed, time-limited instruction: `upload_url`, `params`, `signature` and `expires_at`,
       together with the limits the upload must satisfy.
    2. `POST /assemblies` sends the files to Transloadit, the upload processor,
    as
       `multipart/form-data`, with `params` and `signature` as form fields. Send both verbatim:
       the signature covers those exact bytes, so pretty-printing `params`, reordering its keys,
       or parsing and re-encoding it invalidates the signature. The files go straight to
       Transloadit and never pass through Sterndesk.

    Processing then continues asynchronously, exactly as it does for a dashboard
    upload.

    `POST /rpc/rpc.v1.OrganizationService/ListManualUploads` reports the
    progress of the upload

    created in step 1.
servers:
  - url: https://edge.sterndesk.com
security:
  - apiKey: []
tags:
  - name: rpc.v1.OrganizationService
    description: Organization service RPC for organization method.
  - name: rpc.v1.RootService
    description: RootService provides top-level RPCs.
paths:
  /rpc/rpc.v1.OrganizationService/ListDocumentPages:
    post:
      tags:
        - rpc.v1.OrganizationService
      summary: ListDocumentPages
      description: list document pages
      operationId: rpc.v1.OrganizationService.ListDocumentPages
      parameters:
        - name: Connect-Protocol-Version
          in: header
          description: Define the version of the Connect protocol
          required: true
          schema:
            $ref: '#/components/schemas/connect-protocol-version'
          example: 1
        - name: Connect-Timeout-Ms
          in: header
          description: Define the timeout, in ms
          schema:
            $ref: '#/components/schemas/connect-timeout-header'
          example: 1000
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rpc.v1.ListDocumentPagesRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpc.v1.ListDocumentPagesResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
components:
  schemas:
    connect-protocol-version:
      type: number
      examples:
        - 1
      title: Connect-Protocol-Version
      description: Define the version of the Connect protocol
      const: 1
    connect-timeout-header:
      type: number
      examples:
        - 1000
      title: Connect-Timeout-Ms
      description: Define the timeout, in ms
    rpc.v1.ListDocumentPagesRequest:
      type: object
      properties:
        documentId:
          type: string
          title: document_id
          format: uuid
          description: ID of the document to retrieve pages for
      title: ListDocumentPagesRequest
      additionalProperties: false
      description: New request to list document pages
    rpc.v1.ListDocumentPagesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/rpc.v1.ListDocumentPagesResponse.Item'
          title: items
          description: List of document pages
      title: ListDocumentPagesResponse
      additionalProperties: false
      description: New response that contains a list of document pages
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/connect.error_details.Any'
          description: >-
            A list of messages that carry the error details. There is no limit
            on the number of messages.
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    rpc.v1.ListDocumentPagesResponse.Item:
      type: object
      properties:
        documentId:
          type: string
          title: document_id
          description: ID of the document
        pageIndex:
          type: string
          title: page_index
          format: int64
          description: Index of the page
        markdownRepresentation:
          type: string
          title: markdown_representation
          description: Markdown representation of the page
        primaryOrientation:
          type: integer
          title: primary_orientation
          format: int32
          description: The primary orientation
        primaryLanguageIso6393:
          type: string
          title: primary_language_iso639_3
          description: primary language detected on the page
        primaryLanguageConfidence:
          type: number
          title: primary_language_confidence
          format: double
          description: confidence of the primary language being detected
        rawLlmOutput:
          type:
            - string
            - 'null'
          title: raw_llm_output
          description: the raw llm output
        isPageOfResume:
          type: boolean
          title: is_page_of_resume
          description: Indicates if the page is part of a resume
        isCoverLetter:
          type: boolean
          title: is_cover_letter
          description: Indicates if the page is a cover letter
        isReferenceLetter:
          type: boolean
          title: is_reference_letter
          description: Indicates if the page is a reference letter
        isTrainingsCertificate:
          type: boolean
          title: is_trainings_certificate
          description: Indicates if the page is a trainings certificate
        isMedicalCertificate:
          type: boolean
          title: is_medical_certificate
          description: Indicates if the page is a medical certificate
        isVaccinationBooklet:
          type: boolean
          title: is_vaccination_booklet
          description: Indicates if the page is a vaccination booklet
        isPassport:
          type: boolean
          title: is_passport
          description: Indicates if the page is a passport
        isSeamansBook:
          type: boolean
          title: is_seamans_book
          description: Indicates if the page is a seaman's book
        isAppraisalReview:
          type: boolean
          title: is_appraisal_review
          description: Indicates if the page is an appraisal or review
        classificationReasoning:
          type: array
          items:
            type: string
          title: classification_reasoning
          description: Array of reasons for the classification
        faceDetectedConfidence:
          type:
            - number
            - 'null'
          title: face_detected_confidence
          format: float
          description: confidence that a face is on the page
        faceDetectedBoundingBoxTop:
          type:
            - number
            - 'null'
          title: face_detected_bounding_box_top
          format: float
          description: face location top
        faceDetectedBoundingBoxLeft:
          type:
            - number
            - 'null'
          title: face_detected_bounding_box_left
          format: float
          description: face location left
        faceDetectedBoundingBoxWidth:
          type:
            - number
            - 'null'
          title: face_detected_bounding_box_width
          format: float
          description: face location width
        faceDetectedBoundingBoxHeight:
          type:
            - number
            - 'null'
          title: face_detected_bounding_box_height
          format: float
          description: face location height
        faceDetectedImageUrl:
          type:
            - string
            - 'null'
          title: face_detected_image_url
          description: >-
            face_detected_image_url returns the url for the image of a detected
            face
      title: Item
      additionalProperties: false
      description: Represents a single page of the document
    connect.error_details.Any:
      type: object
      properties:
        type:
          type: string
          description: >-
            A URL that acts as a globally unique identifier for the type of the
            serialized message. For example:
            `type.googleapis.com/google.rpc.ErrorInfo`.
        value:
          type: string
          format: binary
          description: >-
            The Protobuf message, serialized as bytes and base64-encoded. The
            specific message type is identified by the `type` field.
        debug:
          type: object
          title: Debug
          additionalProperties: true
          description: >-
            Deserialized error detail payload. The 'type' field indicates the
            schema. This field is for easier debugging and should not be relied
            upon for application logic.
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message, with an additional debug
        field for ConnectRPC error details.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Personal API key, sent as `Authorization: Bearer <key>`.'

````