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

# Get a project

> Returns one of your account's projects. A project that belongs to another account answers 404, exactly like one that doesn't exist, so a 200 proves the project is yours.



## OpenAPI

````yaml openapi.json GET /v2/projects/{id}
openapi: 3.1.0
info:
  title: Print.App API
  version: 2.0.0
  description: >-
    Server-to-server API for Print.App integrations. Authenticate every request
    with a secret key: `Authorization: Bearer sk_…`. Never call it from a
    browser.
servers:
  - url: https://api.print.app
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: The account a secret key belongs to.
  - name: Projects
    description: Your customers' saved designs.
  - name: Designs
    description: The designs (templates) your customers start from.
paths:
  /v2/projects/{id}:
    get:
      tags:
        - Projects
      summary: Get a project
      description: >-
        Returns one of your account's projects. A project that belongs to
        another account answers 404, exactly like one that doesn't exist, so a
        200 proves the project is yours.
      operationId: getProject
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The `projectId` from the editor's `app:saved` event.
      responses:
        '200':
          description: The project.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
              example:
                object: project
                id: project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
                title: Business Card
                status: submitted
                product:
                  id: sku-123
                  ref: cart-line-7f3a
                userId: customer-1001
                userData:
                  id: customer-1001
                  name: Jane Doe
                  email: jane@example.com
                designId: design_01J8Z9K2M3N4P5Q6R7S8T9V0W1
                created: '2026-10-17T09:12:03Z'
                modified: '2026-10-17T09:20:41Z'
                pages:
                  - index: 0
                    previewUrl: >-
                      https://d1p81tn8mwpox2.cloudfront.net/?k=s3%3A%2F%2Fapp-print-cdn%2Fcontent_a1.png&size=1000
                  - index: 1
                    previewUrl: >-
                      https://d1p81tn8mwpox2.cloudfront.net/?k=s3%3A%2F%2Fapp-print-cdn%2Fcontent_b2.png&size=1000
                exports:
                  pdf: >-
                    https://pdf.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
                  png: >-
                    https://png.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
                  jpeg: >-
                    https://jpeg.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
                  tiff: >-
                    https://tiff.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
        '401':
          description: Missing, unknown, revoked or expired secret key.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: unauthorized
                message: >-
                  Missing or invalid secret key. Send it as "Authorization:
                  Bearer sk_…".
                requestId: FZn-uhymjoEEJow=
        '403':
          description: The account is suspended for an unpaid invoice.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: account_suspended
                message: >-
                  This account is suspended. Settle the outstanding invoice in
                  the Print.App dashboard.
                requestId: FZn-uhymjoEEJow=
        '404':
          description: No such project in your account.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: not_found
                message: Project not found.
                requestId: FZn-uhymjoEEJow=
        '429':
          description: >-
            Rate limited by the API gateway. Back off and retry. This response
            comes from the gateway, so its body is `{ "message": "Too Many
            Requests" }`, not the standard error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                message: Too Many Requests
        '500':
          description: >-
            Something failed on our side. Retry; quote the requestId to support
            if it persists.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: internal_error
                message: >-
                  Something went wrong on our side. Retry the request; if it
                  keeps failing, contact support with the requestId.
                requestId: FZn-uhymjoEEJow=
components:
  headers:
    RequestId:
      description: Identifies the request. Quote it when contacting support.
      schema:
        type: string
  schemas:
    Project:
      title: Project
      description: A customer's saved design.
      type: object
      required:
        - object
        - id
        - title
        - status
        - product
        - userId
        - userData
        - designId
        - created
        - modified
        - pages
        - exports
      additionalProperties: false
      properties:
        object:
          type: string
          const: project
        id:
          type: string
          description: The `projectId` from the editor's `app:saved` event.
        title:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - draft
            - saved
            - submitted
          description: >-
            `submitted`: the customer finished the design (the editor's submit).
            `saved`: saved for later. `draft`: autosaved, not yet saved by the
            customer.
        product:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            Exactly the `product` object your page passed to `PrintAppClient`
            when the project was created — for example `{ id, ref }`. Use it to
            check the project was made for the product being ordered. It passes
            through the customer's browser, so treat it as the customer's claim
            about the page, not as proof.
        userId:
          type:
            - string
            - 'null'
          description: The `userId` your page passed to `PrintAppClient`, if any.
        userData:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            Customer details attached to the project by a store plugin or your
            page: `id`, `name`, `email`, `phone`, `info`.
          properties:
            id: {}
            name:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            email:
              type: string
            phone:
              type: string
            info:
              type: string
        designId:
          type:
            - string
            - 'null'
          description: The design (template) the project was made from.
        created:
          type:
            - string
            - 'null'
          format: date-time
        modified:
          type:
            - string
            - 'null'
          format: date-time
          description: Last save.
        pages:
          type: array
          items:
            type: object
            required:
              - index
              - previewUrl
            additionalProperties: false
            properties:
              index:
                type: integer
                minimum: 0
              previewUrl:
                type:
                  - string
                  - 'null'
                description: A preview image of the page.
        exports:
          type: object
          required:
            - pdf
            - png
            - jpeg
            - tiff
          additionalProperties: false
          description: Print files, rendered on request from the project's current state.
          properties:
            pdf:
              type: string
            png:
              type: string
            jpeg:
              type: string
            tiff:
              type: string
      examples:
        - object: project
          id: project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
          title: Business Card
          status: submitted
          product:
            id: sku-123
            ref: cart-line-7f3a
          userId: customer-1001
          userData:
            id: customer-1001
            name: Jane Doe
            email: jane@example.com
          designId: design_01J8Z9K2M3N4P5Q6R7S8T9V0W1
          created: '2026-10-17T09:12:03Z'
          modified: '2026-10-17T09:20:41Z'
          pages:
            - index: 0
              previewUrl: >-
                https://d1p81tn8mwpox2.cloudfront.net/?k=s3%3A%2F%2Fapp-print-cdn%2Fcontent_a1.png&size=1000
            - index: 1
              previewUrl: >-
                https://d1p81tn8mwpox2.cloudfront.net/?k=s3%3A%2F%2Fapp-print-cdn%2Fcontent_b2.png&size=1000
          exports:
            pdf: https://pdf.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
            png: https://png.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
            jpeg: >-
              https://jpeg.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
            tiff: >-
              https://tiff.print.app/project_2b6f1c9e-8d0a-4c3e-9f57-0c1d2e3f4a5b
    Error:
      title: Error
      description: >-
        Every error the API itself returns. Match on `code`; `message` is for
        people and may be reworded.
      type: object
      required:
        - error
        - code
        - message
        - requestId
      additionalProperties: false
      properties:
        error:
          type: boolean
          const: true
        code:
          type: string
          enum:
            - unauthorized
            - account_suspended
            - invalid_request
            - not_found
            - route_not_found
            - internal_error
          description: >-
            `unauthorized` (401): missing, unknown, revoked or expired secret
            key. `account_suspended` (403): the account has an unpaid invoice.
            `invalid_request` (400): a parameter is malformed — see `param`.
            `not_found` (404): no such resource in your account.
            `route_not_found` (404): no such endpoint. `internal_error` (500):
            retry; contact support with the `requestId` if it persists.
        message:
          type: string
        param:
          type: string
          description: 'For `invalid_request`: the parameter at fault.'
        requestId:
          type: string
          description: >-
            Also sent as the `x-request-id` header. Quote it when contacting
            support.
      examples:
        - error: true
          code: invalid_request
          message: limit must be an integer from 1 to 100.
          param: limit
          requestId: FZn-uhymjoEEJow=
    GatewayError:
      type: object
      properties:
        message:
          type: string
      description: Returned by the API gateway itself (429).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A secret key from Print.App admin → Domains → Secret keys, sent as
        `Authorization: Bearer sk_…`. Server-side only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.