Dynamic Mockups API
  • ๐Ÿ”‘Get your API Key
  • ๐Ÿ‘‹Get support via Slack
  • ๐Ÿš€Get your first render in 1 minute
  • Getting Started
    • How does the API work?
    • How can I get my API key?
    • How are API calls billed?
    • How can I get support?
    • Frequently Asked Questions
    • Troubleshooting
  • API REFERENCE
    • Render API
    • Get Mockups API
    • Get Collections API
    • PSD Upload API
  • PRODUCT API REFERENCE
    • Render Product Images API
    • Get Products API
  • Mockup Editor SDK
    • Embed Mockup Editor
    • Embed in bubble.io
    • Editor Configuration
  • Knowledge Base
    • Tutorials
      • PSD Formatting Guide for Uploading to Dynamic Mockups
      • How to provide image link from Google Drive to Render API
      • How to render images using Zapier
      • How to render images using Make
    • Changelog
    • Photoshop API Feature Support
Powered by GitBook
On this page

Was this helpful?

  1. API REFERENCE

Get Collections API

PreviousGet Mockups APINextPSD Upload API

Last updated 4 months ago

Was this helpful?

Export OpenAPI specification for Get Collections API

Use Collection UUID to filter Mockups

Collections are powerful and give you more flexibility and organization in your project.

This way you can communicate with all mockups inside a collection instead of getting them all without knowing which one you exactly need.

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.

Use Collection UUID as collection_uuid an optional query parameter in to list mockups that belong to the provided collection UUID.

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 with an optional collection_uuid filter.

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

Get Mockups API
Get Mockups API
Render API
3KB
get_collections_api.json

Get Collections

get

Retrieves a list of available collections.

Authorizations
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
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": ""
}
  • GETGet Collections
  • Use Collection UUID to filter Mockups
  • Example Use case