Photo mockups

Retrieve a single photo mockup

Returns mockup metadata and print-area summaries. Use the mockup_id with POST /api/v1/photo-mockups/{mockup_id}/render to render artwork.

get/api/v1/photo-mockups/{mockup_id}

Request

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

Path parameters

mockup_idstring required

Id of the photo mockup to read, as returned when it was created.

Response

Successful Response

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",
    "quads": [
      {
        "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",
    "surfaces": [
      {
        "bbox": {
          "height": 1552,
          "width": 1244,
          "x": 402,
          "y": 286
        },
        "points": [
          [
            402,
            318
          ],
          [
            724,
            286
          ],
          [
            1324,
            286
          ],
          [
            1646,
            318
          ],
          [
            1646,
            742
          ],
          [
            1452,
            806
          ],
          [
            1452,
            1838
          ],
          [
            596,
            1838
          ],
          [
            596,
            806
          ],
          [
            402,
            742
          ]
        ],
        "surface_uuid": "733ee99a-f41f-4b9b-bf33-2ffa489f96db"
      }
    ],
    "updated_at": "2026-09-18T10:41:07.118204Z",
    "version": 1,
    "thumbnail_url": null
  },
  "success": true
}

Changes

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