Catalogs API

Get Catalogs

get

Retrieves a list of available catalogs for the authenticated user.

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

Responses

200

A list of catalogs retrieved successfully.

application/json

400

Bad request due to invalid input parameters.

401

Unauthorized request, invalid or missing API key.

get

/catalogs

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "uuid": "a1b2c3d4-e5f6-4a5b-9c8d-1e2f3a4b5c6d",
      "name": "My Brand Catalog",
      "type": "custom",
      "created_at": "2024-08-28 13:11:05 UTC",
      "created_at_timestamp": 1724850665
    }
  ],
  "success": true,
  "message": ""
}

Export OpenAPI specification for the Get Mockups API

3KB

catalogs_api.json

Open

Use catalog_uuid to filter collections and mockups

Catalogs are powerful and give you more flexibility and organization in your projects.

Use the Catalog UUID as catalog_uuid an optional query parameter in the Get Mockups API and Collections API to list mockups and collections that belong to the provided catalog UUID.

This way, you can list only specific mockups and collections from the chosen catalog and switch between them as needed.

Example Use Cases

There are many use cases where you can find the catalog useful:

Multiple stores

You run several e-commerce stores and want each store to show only its own mockups and collections.

Season-specific catalogs

You keep separate catalogs for different seasons so you can quickly switch between winter and summer mockups.

Client-based catalogs Agencies working with many clients can store each client’s collections and mockups in their own dedicated catalog for cleaner organization.

Campaign-based catalogs For marketing teams, each major campaign (e.g., “Back to School,” “Halloween,” “Black Friday”) can get its own catalog of relevant mockups and collections.

Platform-specific catalogs If you publish to multiple platforms like Etsy, Shopify, Amazon, or WooCommerce, you may want different mockup sets optimized for each platform’s image style and requirements.

Experimental or beta content If you test new mockups or designs, keep them in a “Beta” or “Experimental” catalog that doesn’t affect the main production workflow.

Different membership access Some mockups may be restricted to specific users or membership tiers; you can keep that in a separate catalog to control how it’s accessed.

Tell us about your use case and how the catalog feature fits into your workflow.