Collections API

Get Collections

get

Retrieves a list of available collections. Optionally filter by catalog UUID.

Authorizations

apiKeyAuth

x-api-keystringRequired

API key required for authentication.

Query parameters

catalog_uuidstringOptional

Optional UUID of the catalog to filter collections by.

Example: a1b2c3d4-e5f6-4a5b-9c8d-1e2f3a4b5c6d

include_all_catalogsbooleanOptional

Optional parameter to include collections from all catalogs. If false or omitted, only collections from the default catalog are returned. Set to true to fetch from all catalogs.

Example: false

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 collections retrieved successfully.

application/json

400

Bad request due to invalid input parameters.

401

Unauthorized request, invalid or missing API key.

get

/collections

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "uuid": "f63c0cfa-f106-463e-bbf9-5514b5164245",
      "name": "Coffee Mugs collection",
      "mockup_count": 2,
      "created_at": "2024-08-28 13:11:05 UTC",
      "updated_at": "2024-08-28 13:11:05 UTC",
      "created_at_timestamp": 1724850665,
      "updated_at_timestamp": 1724850665
    }
  ],
  "success": true,
  "message": ""
}

Create Collection

post

Creates a new collection.

Authorizations

apiKeyAuth

x-api-keystringRequired

API key required for authentication.

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

Body

application/json

namestringRequired

The name of the collection to create.

Example: My new collection

catalog_uuidstring | nullableOptional

Optional UUID of the catalog to place this collection in. If not provided, uses the default catalog.

Example: a1b2c3d4-e5f6-4a5b-9c8d-1e2f3a4b5c6d

Responses

200

Collection created successfully.

application/json

400

Bad request due to invalid input parameters.

401

Unauthorized request, invalid or missing API key.

post

/collections

HTTPcURLJavaScriptPython

POST /api/v1/collections HTTP/1.1
Host: app.dynamicmockups.com
x-api-key: text
Accept: application/json
Content-Type: application/json
Content-Length: 82

{
  "name": "My new collection",
  "catalog_uuid": "a1b2c3d4-e5f6-4a5b-9c8d-1e2f3a4b5c6d"
}

{
  "data": {
    "id": 43,
    "uuid": "c55d2d7c-9517-43d9-b182-e16497dd37bb",
    "workspace_id": 38,
    "catalog_id": 1,
    "name": "Test new collection upload",
    "slug": "test-new-collection-upload",
    "is_published": 1,
    "created_at": "2025-10-23T12:40:42.000000Z",
    "updated_at": "2025-10-23T12:40:42.000000Z"
  },
  "success": true,
  "message": ""
}

Export OpenAPI specification for Collections API

8KB

collections_api.json

Open

Example Use case

Let's say you need to render images for all tea mugs with your company logo on them, but there's a problem: you have more than 100 mug mockups, and you have mugs for coffee, tea, and oatmeal.

Without collections, you would need to hardcode more than 30 mockup UUIDs manually for each tea mug.

The best way to achieve flexibility and render only mugs that are designed for the tea is to create a collection of "Tea mugs", put all tea mug mockups inside that collection, and call Get Mockups API with an optional collection_uuid filter.

Now that you have all the tea mug mockups retrieved, you can easily call Render API for each tea mug mockup and render an image.