---
title: "Retrieve a list of photo mockups"
method: GET
path: "/api/v1/sudoai/2d-mockups"
tags: ["Photo mockups"]
deprecated: true
---

# Retrieve a list of photo mockups

`GET /api/v1/sudoai/2d-mockups`

## Request

- Base URL: `https://api.sudomock.com`
- URL: `https://api.sudomock.com/api/v1/sudoai/2d-mockups`
- Auth: API key in header `x-api-key`

> **Deprecated.**

Returns a paginated list of the user's photo mockups with print area summaries. Each mockup includes its status, thumbnail, dimensions, and print area names/bboxes. Ordered by creation date (newest first).

## Query parameters

- `limit` integer: Items per page (max 100)
- `offset` integer: Pagination offset
- `customizable_only` boolean: Return only mockups ready for customization

## Response `200`

Successful Response

- PhotoMockupList
  - `data` PhotoMockup[], required: The mockups on this page, newest first.
    - `mockup_id` string, required: Unique identifier for the mockup.
    - `name` string, required: Display name of the mockup.
    - `status` string, required: Preparation state of the mockup: draft, processing, ready or error.
    - `customizable` boolean, required: Whether the mockup is ready to accept artwork.
    - `thumbnail_url` string, nullable: URL of the mockup's thumbnail image.
    - `source_width` integer, nullable: Width of the source image in pixels.
    - `source_height` integer, nullable: Height of the source image in pixels.
    - `print_areas` PhotoMockupPrintArea[]: Printable areas saved on this mockup.
      - `print_area_id` string, required: Unique identifier for the print area.
      - `points` array[], nullable: The area's four [x, y] corner points in source image pixels.
        - number[]
      - `name` string, nullable: Label for the print area, such as 'Front'.
      - `sort_order` integer: Position of this print area in the mockup's own order, starting at 0.
    - `version` integer: Version of this mockup's saved definition.
    - `created_at` string, date-time, required: When the mockup was created.
    - `updated_at` string, date-time, required: When the mockup was last updated.
  - `total` integer, required: Total number of mockups matching the query.
  - `limit` integer, required: Results per page.
  - `offset` integer, required: Number of mockups skipped before this page.
  - `success` true: Always true on a successful response.

---

[API](https://skmtc.dev/sudomock/apis/sudomock-api.md) · [All operations](https://skmtc.dev/sudomock/apis/sudomock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sudomock/apis/sudomock-api/revisions/c1cc24006c60?raw)