Welcome to the Mimeeq API

Start building with the Mimeeq Admin API: explore resources, set up authentication, and make your first request.

Connect Mimeeq to your business systems and automate how you manage product, pricing, and customer data.

The Mimeeq Admin API is a REST API for developers building integrations with Mimeeq. This reference explains the available endpoints, the permissions each operation needs, and the request and response formats.

Start here

1. Set up access. In the Mimeeq app, go to Settings → API Management → API Keys and create an Admin API key with the scopes your integration needs. See Authentication.

2. Make a read-only request. Try the example below to check that your key and permissions work.

3. Build your integration. Choose a resource from the reference, then check its parameters, response schema, and required scope.

Keep Admin API keys on your server. Do not include them in browser code, public repositories, or screenshots. Admin API keys and Embed API keys serve different purposes; this section documents the Admin API.

What would you like to connect?

Products and configuration

Work with Products, organize them with Product Categories and Product Groups, and manage reusable Global Option Sets and Collection Sets.

Use Galleries to manage named image and video galleries for the configurator.

Pricing and item data

Explore Price Lists, Item Masters, and Market Cost Prices for pricing and item-data integrations.

Customers and sales

Work with Companies, their Contacts, Carts, and Quotations.

Each resource page lists its supported operations. Check that reference before designing a workflow; not every resource supports the same actions.

Make your first request

This example lists up to five galleries. Use an Admin API key with the galleries:read scope and make the request from your server or local development terminal.

Base URL: https://admin.mimeeqapi.com

curl --request GET \
  --url 'https://admin.mimeeqapi.com/v1/galleries?limit=5' \
  --header "Authorization: Bearer $MIMEEQ_ADMIN_API_KEY" \
  --header 'Accept: application/json'

Set MIMEEQ_ADMIN_API_KEY securely in your environment before running the example. It is a placeholder variable, not a key supplied by this documentation.

A successful list response contains the results in data and pagination information in page. An empty data array can simply mean that your account has no matching galleries.

Open Galleries for the complete endpoint details and response examples.

Know the essentials

• Authentication and scopes: Send your key as a bearer token. Each operation states its required scope. See Authentication.

• Responses: Successful responses put their payload under data. Write-response details vary by resource. See Response shape.

• Pagination: List responses provide page.nextCursor; use it to request the next page until it is null. See Pagination.

• Errors: Check the error code and message. Keep the requestId when reporting an issue. See Errors.

• Deletion: Resource deletion is handled in the Mimeeq app. See Deleting resources.

The documented base URL is the production API. Start with read-only requests; write operations can change your account's data.

Explore the reference

Use Models to inspect data schemas, or download the OpenAPI specification for use with compatible development tools.

Looking for help using the app rather than building an integration? Visit Using Mimeeq.