> 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/roles/list-roles.md).

# List Roles

List the Tier 1 account roles available in your Mimeeq account. Use this request to find a `roleId` before reading a role, updating it or assigning roles to an invited user.

Each role contains its name, `ACTIVE` or `INACTIVE` status and permission identifiers. The response is a single data array with no pagination or filter parameters.

Use Get Role to inspect assigned user IDs and List Role Permissions for descriptions of the available permissions. These roles do not manage Tier 2 dealer or partner access.

Requires the `roles:read` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"tags":[{"name":"Roles","description":"Manage roles for **Tier 1 users in your Mimeeq account**. A role groups the permissions that control what an account user can view or change in the Mimeeq admin app.\n\nThese endpoints manage Tier 1 account roles. They do not manage Tier 2 dealer or partner roles.\n\n## What you can do\n\n| Task | Operation |\n| --- | --- |\n| Find existing roles | [List Roles](https://help.mimeeq.com/developers/roles/list-roles) |\n| Discover available permission identifiers | [List Role Permissions](https://help.mimeeq.com/developers/roles/list-role-permissions) |\n| Read a role and its assigned users | [Get Role](https://help.mimeeq.com/developers/roles/get-role) |\n| Add a role with permissions and user assignments | [Create Role](https://help.mimeeq.com/developers/roles/create-role) |\n| Change a role or its assignments | [Update Role](https://help.mimeeq.com/developers/roles/update-role) |\n\n## Before you start\n\nYour API key needs `roles:read` to read roles and available permissions, or `roles:write` to create or update them. API-key scopes control which API requests your integration can make. Role permissions control what the assigned users can do in Mimeeq.\n\nTo assign users, use user IDs returned by [List Users](https://help.mimeeq.com/developers/users/list-users) for the same Mimeeq account.\n\n## Updating user assignments\n\n> **The supplied user list replaces the current assignments.** Include every user you want to keep. Send an empty `userIds` array to remove all assignments, or omit `userIds` to leave them unchanged.\n\nStart with Get Role, prepare the complete list of users, and then submit Update Role. A new role is inactive unless you set its status to `ACTIVE`."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production API"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"RolesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"string","pattern":"^ROLE-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"roleName":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"permissions":{"type":"array","items":{"type":"string"}}},"required":["roleId","roleName","status","permissions"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Roles (GET /v1/roles). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"PublicError":{"description":"An API error response. Use code and the HTTP status to classify the failure, message and optional details for context, and requestId when reporting it. Edge firewall responses may omit requestId.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string","description":"Present on every error the API itself returns; absent when the edge firewall rejected the request."},"details":{"description":"Optional error-specific details (e.g. per-field validation reasons)."}}}}},"paths":{"/v1/roles":{"get":{"summary":"List Roles","tags":["Roles"],"description":"List the Tier 1 account roles available in your Mimeeq account. Use this request to find a `roleId` before reading a role, updating it or assigning roles to an invited user.\n\nEach role contains its name, `ACTIVE` or `INACTIVE` status and permission identifiers. The response is a single data array with no pagination or filter parameters.\n\nUse Get Role to inspect assigned user IDs and List Role Permissions for descriptions of the available permissions. These roles do not manage Tier 2 dealer or partner access.\n\nRequires the `roles:read` scope.","responses":{"200":{"description":"Successful response.","headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolesList"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"429":{"description":"The API key exceeded its request rate (`rate_limit_exceeded`) or its monthly quota (`quota_exceeded`). Both carry `Retry-After`; the `RateLimit-*` headers accompany `rate_limit_exceeded` only, since a spent quota says nothing about the bucket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}}}}}}}
```


---

# 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/roles/list-roles.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.