Get Mockups API

Get Mockups

Retrieves a list of available mockups.

get

/mockups

Authorizations

Query parameters

collection_uuidstring

Optional parameter to filter mockups by collection UUID.

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

Header parameters

Acceptstring · enumrequired

The request must accept JSON responses.

Options: application/json

x-api-keystringrequired

API key required for authentication.

Example: YOUR_API_KEY_HERE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.dynamicmockups.com/api/v1/mockups' \
  --header 'x-api-key: YOUR_API_KEY_HERE' \
  --header 'Accept: application/json'

200

400

401

200

{
  "success": true,
  "message": "",
  "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",
      "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"
        }
      ],
      "smart_objects": [
        {
          "uuid": "a11dbbeb-5a45-4386-80a0-b7c9083a964f",
          "name": "Mug",
          "size": {
            "width": 1000,
            "height": 1000
          },
          "position": {
            "top": 28,
            "left": 153
          }
        }
      ]
    }
  ]
}

A list of mockups retrieved successfully.

Get Specific Mockup

Retrieves a specific mockup using its UUID.

get

/mockup/{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.

Options: application/json

x-api-keystringrequired

API key required for authentication.

Example: YOUR_API_KEY_HERE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.dynamicmockups.com/api/v1/mockup/{uuid}' \
  --header 'x-api-key: text' \
  --header 'Accept: application/json'

200

400

401

404

200

{
  "success": true,
  "message": "",
  "data": {
    "uuid": "0460c0fe-a476-44da-bd2b-9f92a9f5f675",
    "name": "My Coffee Mug",
    "thumbnail": "https://app-design-copilot-localhost.s3.eu-central-1.amazonaws.com/mockup/046/thumbnail.jpg",
    "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/aug76e6bb133d9657164bf0deabc3d24_720.jpg"
      }
    ],
    "smart_objects": [
      {
        "uuid": "a11dbbeb-5a45-4386-80a0-b7c9083a964f",
        "name": "Mug",
        "size": {
          "width": 1000,
          "height": 1000
        },
        "position": {
          "top": 28,
          "left": 153
        }
      }
    ]
  }
}

The mockup retrieved successfully.

Export OpenAPI specification for Get Mockups API

6KB

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