Get Mockups API

Get Mockups

Retrieves a list of available mockups.

GEThttps://app.dynamicmockups.com/api/v1/mockups

Authorization

apiKeyAuth

Query parameters

Header parameters

Response

200400401

A list of mockups retrieved successfully.

Body

application/json

dataarray of object

successboolean

Indicates if the operation was successful.

Example: true

messagestring

A message about the operation.

Example: ""

Request

JavaScriptCurlPython

const response = await fetch('https://app.dynamicmockups.com/api/v1/mockups', {
    method: 'GET',
    headers: {
      "Accept": "application/json",
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "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
          }
        }
      ],
      "collections": [
        {
          "uuid": "f63c0cfa-f106-463e-bbf9-5514b5164245",
          "name": "Coffee Mugs"
        }
      ]
    }
  ],
  "success": true,
  "message": ""
}

collection_uuid optional query parameter

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 gives you a great opportunity 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.