Skip to main content

Admin API Quickstart

The Admin API provides programmatic access to your overall Mimeeq setup and administrative data. Use it to maintain catalog organization and global option sets, work with companies and contacts, read product and cart data, and integrate pricing-data or quotation workflows. Available read and write operations vary by resource; the live reference defines what you can manage.

The Embed API brings products customized by users into your business workflows by retrieving their full configuration details. Use those details in ecommerce, order processing, or other downstream systems. It also supports retrieving calculated prices, listing available products, and generating configuration short codes. It works with configured product data rather than account settings or product setup, and uses a separate Embed API key.

Base URL​

Send Admin API requests to https://admin.mimeeqapi.com/v1.

The Admin API Reference displays the live reference for this API.

Create a Key​

Go to Settings → Customer settings → API Management → API Keys and create an Admin key with the products:read scope. Copy the secret before closing the creation dialog and store it on your server as MIMEEQ_ADMIN_API_KEY.

See the Authorization Guide for permissions, scopes, expiry, and key rotation.

Make Your First Request​

curl 'https://admin.mimeeqapi.com/v1/products?limit=10' \
  -H "Authorization: Bearer ${MIMEEQ_ADMIN_API_KEY}" \
  -H 'Accept: application/json'

The response contains a data array and pagination metadata. For example, a final page with no products looks like this:

{
  "data": [],
  "page": {
    "limit": 10,
    "nextCursor": null
  }
}

When page.nextCursor contains a value, pass it as the cursor query parameter to fetch the next page. The conventions guide includes a complete pagination example.

Choose Your Operations​

The live reference is the source of truth for available resources and operations, required scopes, request fields, and response schemas. It stays up to date as the API evolves.

Supported actions differ by resource. Use the methods listed for your operation; do not assume every resource supports creation, updates, or deletion.

Diagnose a Failed Request​

First check the HTTP status and error code. A missing Bearer header returns unauthenticated; an unknown, expired, or revoked key returns invalid_key; a missing scope returns scope_denied.

Open API Management → Requests Log to inspect requests associated with a recognized Admin key. Include the error's requestId when contacting support. See Requests Log for its coverage and filters.

Next Steps​