> 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/company-groups.md).

# Company Groups

Group companies in your Mimeeq account so that other settings can target them together. Company groups are used by product visibility, cart pricing rules and 3D export.

Use this section to keep groups and their member companies in step with segments in your CRM or ERP. The companies themselves are managed through Companies; a company deleted there leaves all its groups.

### What you can do

| Task                           | Reference                                                                                                   |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| Find available company groups  | [List Company Groups](https://help.mimeeq.com/api/company-groups/list-company-groups)                       |
| Add a new company group        | [Create Company Group](https://help.mimeeq.com/api/company-groups/create-company-group)                     |
| Read one company group         | [Get Company Group](https://help.mimeeq.com/api/company-groups/get-company-group)                           |
| Change company group           | [Update Company Group](https://help.mimeeq.com/api/company-groups/update-company-group)                     |
| Remove a company group         | [Delete Company Group](https://help.mimeeq.com/api/company-groups/delete-company-group)                     |
| Change company group companies | [Update Company Group Companies](https://help.mimeeq.com/api/company-groups/update-company-group-companies) |
| Add Company Group Companies    | [Add Company Group Companies](https://help.mimeeq.com/api/company-groups/add-company-group-companies)       |
| Remove Company Group Companies | [Remove Company Group Companies](https://help.mimeeq.com/api/company-groups/remove-company-group-companies) |
| Copy company group             | [Duplicate Company Group](https://help.mimeeq.com/api/company-groups/duplicate-company-group)               |

### Before you start

Your API key needs `companyGroups:read` to read these resources and `companyGroups:write` for write operations. Deleting a company group needs `companyGroups:delete`.

### Important behaviour

Names do not have to be unique. New groups are `INACTIVE` with 3D export allowed unless you set otherwise; `canExport3d` lets the group's companies export 3D models where your account's export setting leaves that decision to company groups.

Update Company Group Companies replaces the whole member list; Add and Remove change only the companies you name and ignore ids that already are, or are not, members. Every company you add must belong to your account.

Deleting a group keeps its companies. A group that products are restricted to, or that a cart pricing rule targets, cannot be deleted. Duplicating a group copies its member companies and product links, but not the pricing rules that target it.


---

# 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/company-groups.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.
