Photo mockups

Retrieve a list of photo mockups

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).

get/api/v1/photo-mockups

Request

  • Base URL: https://api.sudomock.com
  • URL: https://api.sudomock.com/api/v1/photo-mockups
  • Auth: API key in header x-api-key

Query parameters

limitinteger

Items per page (max 100)

offsetinteger

Pagination offset

customizable_onlyboolean

Return only mockups ready for customization

Response

Successful Response

totalinteger required

Total number of mockups matching the query.

limitinteger required

Results per page.

offsetinteger required

Number of mockups skipped before this page.

successtrue

Always true on a successful response.

Example response

{
  "data": [
    {
      "created_at": "2026-09-18T10:24:31.482913Z",
      "customizable": true,
      "mockup_id": "893ea326-278b-480b-b130-87dd6aee06dc",
      "name": "Front view",
      "print_areas": [
        {
          "name": "Front",
          "points": [
            [
              518,
              646
            ],
            [
              1534,
              638
            ],
            [
              1541,
              1662
            ],
            [
              511,
              1670
            ]
          ],
          "print_area_id": "19be48d4-c810-4420-86e3-7ec2a4d85571",
          "sort_order": 0
        }
      ],
      "source_height": 2048,
      "source_width": 2048,
      "status": "ready",
      "updated_at": "2026-09-18T10:41:07.118204Z",
      "version": 1,
      "thumbnail_url": null
    },
    {
      "created_at": "2026-09-16T08:12:55.301764Z",
      "customizable": true,
      "mockup_id": "5c74b1e0-9f38-4a26-b0d5-6e2a83c94f17",
      "name": "Ceramic mug",
      "print_areas": [],
      "source_height": 1600,
      "source_width": 1600,
      "status": "ready",
      "updated_at": "2026-09-16T08:13:42.669102Z",
      "version": 1,
      "thumbnail_url": null
    }
  ],
  "limit": 20,
  "offset": 0,
  "success": true,
  "total": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.