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

# Every proof on a job

> Requires ALL of the scopes proofs.read, jobs.read.

Required scopes: `proofs.read`, `jobs.read`.


## OpenAPI

````yaml GET /v1/jobs/{jobId}/proofs
openapi: 3.1.0
info:
  title: PRINTOOLS API
  version: 1.0.0
  description: >-
    The PRINTOOLS public REST API. This document is generated from the live
    route table and service GraphQL SDL; do not edit it by hand.


    Every 2xx response has {status, message, data}. Every non-2xx response has
    {error, message, status: false}.


    Tenant credential: send X-API-Key only. It is bound to one shop.
    X-PrintTools-Organization-Id is optional for that credential and, if sent,
    must match its shop.


    Partner credential: send X-API-Key, X-API-Secret, Authorization: Bearer
    <Cognito access token>, and X-PrintTools-Organization-Id. The OAuth flow is
    documented at https://app.printools.io/api/index.html#partner-auth.


    Read live limits from GET /v1/reference/limits. Field shapes are projected
    from operation declarations; local endpoints have explicit handler-derived
    schemas.
servers:
  - url: https://api.printools.io
    description: Production
security: []
externalDocs:
  description: Getting started, OAuth and webhook guidance
  url: https://app.printools.io/api/index.html
paths:
  /v1/jobs/{jobId}/proofs:
    get:
      tags:
        - jobs
      summary: Every proof on a job.
      description: Requires ALL of the scopes proofs.read, jobs.read.
      operationId: get_v1_jobs_jobId_proofs
      parameters:
        - name: jobId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: 11111111-2222-3333-4444-555555555555
          description: UUID.
        - name: X-PrintTools-Organization-Id
          in: header
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Tenant credential: optional and, when sent, must equal the shop
            bound to the key. Partner credential: required; it selects an
            organisation the user previously authorised.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Output_Proof'
        '400':
          description: >-
            Validation or request-shape error. Correct the request before
            retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Credential authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            WWW-Authenticate:
              schema:
                type: string
                example: ApiKey
        '403':
          description: >-
            The credential lacks a required scope, or its actor lacks
            permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The resource or endpoint was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            Conflict, including idempotency-key reuse or an in-flight idempotent
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The JSON request body exceeds the published size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Retry after the returned delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Whole seconds to wait.
              schema:
                type: integer
                minimum: 0
        '500':
          description: An unexpected server error. A retry can be appropriate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - tenantApiKey: []
        - partnerApiKey: []
          partnerApiSecret: []
          partnerBearer: []
      x-codeSamples:
        - lang: curl
          label: Tenant credential
          source: >-
            curl --request GET
            'https://api.printools.io/v1/jobs/11111111-2222-3333-4444-555555555555/proofs'
            \
              --header 'X-API-Key: $PRINTOOLS_API_KEY'
components:
  schemas:
    Success:
      type: object
      required:
        - status
        - message
        - data
      properties:
        status:
          type: boolean
          description: >-
            The actual resolver result. It can be false when an operation
            returns false or null without throwing.
        message:
          type: string
          example: OK
        data: {}
      description: Every 2xx response uses this envelope.
    Output_Proof:
      type: object
      properties:
        id:
          type: string
        jobId:
          type: string
        jobGroupId:
          type:
            - string
            - 'null'
        jobGroupDecorationId:
          type:
            - string
            - 'null'
        mockId:
          type:
            - string
            - 'null'
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        optionLabel:
          type:
            - string
            - 'null'
        imageUrl:
          type:
            - string
            - 'null'
        imageFileName:
          type:
            - string
            - 'null'
        version:
          type: integer
        parentProofId:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/Enum_ProofStatus'
        sentToClientAt:
          type:
            - string
            - 'null'
          format: date-time
        sentToEmail:
          type:
            - string
            - 'null'
        clientDecisionAt:
          type:
            - string
            - 'null'
          format: date-time
        clientDecisionByName:
          type:
            - string
            - 'null'
        clientNotes:
          type:
            - string
            - 'null'
        approvedByEmail:
          type:
            - string
            - 'null'
        approvedByName:
          type:
            - string
            - 'null'
        rejectionReason:
          type:
            - string
            - 'null'
        sortOrder:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        placementSpecs:
          type: array
          items:
            $ref: '#/components/schemas/Output_ProofPlacementSpec'
        itemLinks:
          type: array
          items:
            $ref: '#/components/schemas/Output_ProofItemLink'
      required:
        - id
        - jobId
        - title
        - version
        - status
        - sortOrder
        - createdAt
        - updatedAt
        - placementSpecs
        - itemLinks
    Error:
      type: object
      required:
        - error
        - message
        - status
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
        status:
          type: boolean
          const: false
      description: Every non-2xx response uses this envelope.
    Enum_ProofStatus:
      type: string
      enum:
        - Draft
        - InternallyApproved
        - SentToClient
        - ClientApproved
        - ClientRejected
        - NeedsRevision
    Output_ProofPlacementSpec:
      type: object
      properties:
        id:
          type: string
        proofId:
          type: string
        placement:
          type: string
        method:
          type:
            - string
            - 'null'
        widthCm:
          type:
            - number
            - 'null'
        lengthCm:
          type:
            - number
            - 'null'
        necklineDropCm:
          type:
            - number
            - 'null'
        colours:
          type: array
          items:
            $ref: '#/components/schemas/Output_DecorationColour'
        sortOrder:
          type: integer
        jobGroupDecorationId:
          type:
            - string
            - 'null'
          description: >-
            The job-group decoration this spec describes. Null for a spec typed
            by hand for a print that isn't on the quote.
        groupName:
          type:
            - string
            - 'null'
          description: >-
            PR-01 WS-1.2 — server-resolved display fields, projected the same
            way PortalProofItemLink projects group/style/colour
            (portal-service/schema.graphql). Read-only; null when
            jobGroupDecorationId is null or the decoration no longer resolves.
        styleName:
          type:
            - string
            - 'null'
        colour:
          type:
            - string
            - 'null'
        decorationName:
          type:
            - string
            - 'null'
          description: The decoration's own label, as the quote shows it.
      required:
        - id
        - proofId
        - placement
        - colours
        - sortOrder
    Output_ProofItemLink:
      type: object
      properties:
        id:
          type: string
        proofId:
          type: string
        jobGroupId:
          type: string
        jobLineId:
          type:
            - string
            - 'null'
          description: >-
            PT-05 — the garment LINE this link covers, within the group. A group
            may hold

            several garment lines, and a size split has to land on exactly one
            of them.


            Null only on links written before PT-05 whose group held anything
            other than

            one garment line: the migration backfilled the unambiguous case and
            refused to

            invent an attribution for the rest. Those keep the old behaviour,
            ambiguity

            error included, until the proof is re-linked.
        quantity:
          type: integer
        sizeSplit:
          type: array
          items:
            $ref: '#/components/schemas/Output_SizeQty'
        sizeSplitConfirmed:
          type: boolean
      required:
        - id
        - proofId
        - jobGroupId
        - quantity
        - sizeSplit
        - sizeSplitConfirmed
    Output_DecorationColour:
      type: object
      properties:
        name:
          type: string
        isBase:
          type: boolean
      required:
        - name
        - isBase
    Output_SizeQty:
      type: object
      properties:
        size:
          type: string
        qty:
          type: integer
      required:
        - size
        - qty
  securitySchemes:
    tenantApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Tenant credential. This is sufficient by itself.
    partnerApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Partner application client ID.
    partnerApiSecret:
      type: apiKey
      in: header
      name: X-API-Secret
      description: Partner application secret.
    partnerBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito access token obtained through OAuth.

````