Get Mockups API

Get Mockups

get

Retrieves a list of available mockups.

Authorizations

Query parameters

collection_uuidstringOptional

Optional parameter to filter mockups by collection UUID.

Example: f63c0cfa-f106-463e-bbf9-5514b5164245

Header parameters

Acceptstring · enumRequired

The request must accept JSON responses.

Possible values:

x-api-keystringRequired

API key required for authentication.

Example: YOUR_API_KEY_HERE

Responses

200

A list of mockups retrieved successfully.

application/json

400

Bad request due to invalid input parameters.

401

Unauthorized request, invalid or missing API key.

get

HTTPcURLJavaScriptPython

GET /api/v1/mockups HTTP/1.1
Host: app.dynamicmockups.com
x-api-key: text
Accept: application/json

{
  "data": [
    {
      "uuid": "89fbfcb5-e8c0-4e48-bc94-b7e289734cbc",
      "name": "My Coffee Mug",
      "thumbnail": "https://app-design-copilot-localhost.s3.eu-central-1.amazonaws.com/mockup/176/thumbnail.jpg",
      "smart_objects": [
        {
          "uuid": "a11dbbeb-5a45-4386-80a0-b7c9083a964f",
          "name": "Mug",
          "size": {
            "width": 1000,
            "height": 1000
          },
          "position": {
            "top": 28,
            "left": 153
          },
          "print_area_presets": [
            {
              "uuid": "d542b299-7350-495e-8bed-51060318d45c",
              "name": "BottomLeft",
              "thumbnails": [
                {
                  "width": 720,
                  "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/mockup/73993/thumbnails/de676e6bb133d9657164bf0deabc3d24_720.jpg"
                }
              ]
            }
          ]
        }
      ],
      "text_layers": [
        {
          "uuid": "5fea4761-8e6c-458a-b957-313e95c960d0",
          "name": "Text layer example 1"
        }
      ],
      "collections": [
        {
          "uuid": "f63c0cfa-f106-463e-bbf9-5514b5164245",
          "name": "Coffee Mugs"
        }
      ],
      "thumbnails": [
        {
          "width": 720,
          "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/mockup/73993/thumbnails/de676e6bb133d9657164bf0deabc3d24_720.jpg"
        }
      ]
    }
  ],
  "success": true,
  "message": ""
}

Get Specific Mockup

get

Retrieves a specific mockup using its UUID.

Authorizations

Path parameters

uuidstringRequired

The UUID of the mockup to retrieve.

Example: 0460c0fe-a476-44da-bd2b-9f92a9f5f675

Header parameters

Acceptstring · enumRequired

The request must accept JSON responses.

Possible values:

x-api-keystringRequired

API key required for authentication.

Example: YOUR_API_KEY_HERE

Responses

200

The mockup retrieved successfully.

application/json

400

Bad request.

401

Unauthorized request, invalid or missing API key.

404

Mockup with provided UUID not found.

get

HTTPcURLJavaScriptPython

GET /api/v1/mockup/{uuid} HTTP/1.1
Host: app.dynamicmockups.com
x-api-key: text
Accept: application/json

{
  "data": {
    "uuid": "89fbfcb5-e8c0-4e48-bc94-b7e289734cbc",
    "name": "My Coffee Mug",
    "thumbnail": "https://app-design-copilot-localhost.s3.eu-central-1.amazonaws.com/mockup/176/thumbnail.jpg",
    "smart_objects": [
      {
        "uuid": "a11dbbeb-5a45-4386-80a0-b7c9083a964f",
        "name": "Mug",
        "size": {
          "width": 1000,
          "height": 1000
        },
        "position": {
          "top": 28,
          "left": 153
        },
        "print_area_presets": [
          {
            "uuid": "d542b299-7350-495e-8bed-51060318d45c",
            "name": "BottomLeft",
            "thumbnails": [
              {
                "width": 720,
                "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/mockup/73993/thumbnails/de676e6bb133d9657164bf0deabc3d24_720.jpg"
              }
            ]
          }
        ]
      }
    ],
    "text_layers": [
      {
        "uuid": "5fea4761-8e6c-458a-b957-313e95c960d0",
        "name": "Text layer example 1"
      }
    ],
    "collections": [
      {
        "uuid": "f63c0cfa-f106-463e-bbf9-5514b5164245",
        "name": "Coffee Mugs"
      }
    ],
    "thumbnails": [
      {
        "width": 720,
        "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/mockup/73993/thumbnails/de676e6bb133d9657164bf0deabc3d24_720.jpg"
      }
    ]
  },
  "success": true,
  "message": ""
}

Export OpenAPI specification for Get Mockups API

7KB

get_mockups_api.json

collection_uuid optional query parameter for Get Mockups

On the My Mockups page on the web application, you can create collections and add mockups to them to achieve better organization and more flexibility.

This optional filter allows you to list only mockups that belong to specific collections.

Also, you can get collections UUIDs by calling Get Collections API which will retrieve all created collections and their UUIDs.