API Keys in Mimeeq: what they're for and how to create yours

Content

1. Overview
2. Creating an Admin API key
3. What about the key I already have?
4. Keeping an eye on your API activity
5. Where to go next

Overview

Mimeeq gives you two ways to connect your own systems to your Mimeeq account: the Embed API and the Admin API. This article explains what each one does, how to generate and manage the keys that authenticate them, and what happens to any key you're already using. You'll find everything described here under Settings → Customer settings → API Management.

Embed API is what powers your customer-facing configurator experience. It handles product listings, configuration details, pricing, and short codes — the things your website or storefront needs to show a configured product and its price. If you already have an integration built with Mimeeq, it almost certainly uses this API.

Admin API is newer, and it's for managing your account and catalog data from your own systems: companies, contacts, products, quotations, carts, price lists, option sets, and similar setup data. Use it when you want to sync Mimeeq with an ERP, CRM, e-commerce platform, or internal tool — for example, pushing quotations into your order system or keeping company records in sync.

Creating an Admin API key

1. Go to Settings → Customer settings → API Management → API Keys.
2. In the Admin API Keys section, click + Create Admin Key.
3. Give the key a name (required) and, optionally, a description and an expiry date.
4. Under Select Scopes, choose only the resources your integration actually needs (for example, just Companies and Contacts), or check All scopes if the integration needs full access.
5. Click Create.

We recommend scoping keys narrowly and giving each integration its own key, so you can tell them apart in the requests log and revoke one without affecting the others.

What about the key I already have?

If you've been using Mimeeq's API before today, you have an Embed API key — it now lives under API Management → API Keys → Embed API Keys, listed as your "Legacy Embed Key" (or similarly named). This is simply a new home for it in the interface:

• The key's value hasn't changed.
• Your existing integration keeps working exactly as before.
• You don't need to do anything unless you want to.

The only time this key changes is if you choose to regenerate it — in which case the old value stops working immediately, and any integration using it will need to be updated with the new one. This key is separate from the new Admin API keys described above; you don't need an Embed API key to create an Admin API key, or vice versa, since they authenticate two different APIs.

Keeping an eye on your API activity

The Requests Log tab (next to API Keys) shows the calls made with your keys over the last 30 days: timestamp, method, endpoint, status code, which key was used, and response time. Click any row to see full details, including whether the request was authorized, which scope it required, and — for failed requests — the exact error returned.

This is the fastest way to check why an integration isn't working. A 403 with a scope-related error usually means the key wasn't granted the permission the endpoint requires; going back into API Keys and adding that scope (or creating a new key with it) resolves it.

Where to go next

For request and response formats, authentication headers, available endpoints, scopes, pagination, and error codes, see the full developer documentation:

• Admin API introduction
• Admin API reference
• Admin API conventions
• Authorization guide
• Embed API reference
• Working with request logs
• Migrating between API key types

If you're not sure which API or scopes your integration needs, your developer or integration partner can check the reference docs above, or you can reach out to our support team.

Updated on: 14/09/2026