> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/welcome-to-the-mimeeq-api.md).

# 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](https://help.mimeeq.com/developers/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](https://help.mimeeq.com/developers/products), organize them with [Product Categories](https://help.mimeeq.com/developers/product-categories) and [Product Groups](https://help.mimeeq.com/developers/product-groups), and manage reusable [Global Option Sets](https://help.mimeeq.com/developers/global-option-sets) and [Collection Sets](https://help.mimeeq.com/developers/collection-sets).

Use [Galleries](https://help.mimeeq.com/developers/galleries) to manage named image and video galleries for the configurator.

### Pricing and item data

Explore [Price Lists](https://help.mimeeq.com/developers/price-lists), [Item Masters](https://help.mimeeq.com/developers/item-masters), and [Market Cost Prices](https://help.mimeeq.com/developers/market-cost-prices) for pricing and item-data integrations.

### Customers and sales

Work with [Companies](https://help.mimeeq.com/developers/companies), their [Contacts](https://help.mimeeq.com/developers/contacts), [Carts](https://help.mimeeq.com/developers/carts), and [Quotations](https://help.mimeeq.com/developers/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`

```bash
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](https://help.mimeeq.com/developers/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](https://help.mimeeq.com/developers/authentication).
* **Responses:** Successful responses put their payload under `data`. Write-response details vary by resource. See [Response shape](https://help.mimeeq.com/developers/response-shape).
* **Pagination:** List responses provide `page.nextCursor`; use it to request the next page until it is `null`. See [Pagination](https://help.mimeeq.com/developers/pagination).
* **Errors:** Check the error code and message. Keep the `requestId` when reporting an issue. See [Errors](https://help.mimeeq.com/developers/errors).
* **Deletion:** Resource deletion is handled in the Mimeeq app. See [Deleting resources](https://help.mimeeq.com/developers/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](https://help.mimeeq.com/developers/models) to inspect data schemas, or [download the OpenAPI specification](https://openapi.gitbook.com/o/AyHlBmMgltNsI7YJSmDC/spec/mimeeq-admin-api.json) for use with compatible development tools.

Looking for help using the app rather than building an integration? Visit [Using Mimeeq](https://help.mimeeq.com/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/welcome-to-the-mimeeq-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.