---
title: "List"
method: GET
path: "/groups"
tags: ["Groups"]
---

# List

`GET /groups`

## Request

- Base URL: `https://api.mirurobotics.com/beta`
- URL: `https://api.mirurobotics.com/beta/groups`
- Auth: API key in header `X-API-Key`

List groups.

## Query parameters

- `offset` integer
- `limit` integer
- `order_by` GroupOrderBy[]
- `expand` GroupListExpansion[]
- `id` string[]
- `name` string[]
- `parent_id` string[]

## Response `200`

Successfully listed the groups.

- GroupList
  - `object` 'list', required: The object type, which is always `list`.
  - `total_count` integer: The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.
  - `limit` integer, required: The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.
  - `offset` integer, required: The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.
  - `has_more` boolean, required: True if there are more items in the list to return. False if there are no more items to return.
  - `data` Group[], required: The list of groups.
    - `object` 'group', required: The object type, which is always `group`.
    - `id` string, required: ID of the group.
    - `name` string, required: Name of the group.
    - `parent_id` string, nullable, required: ID of the parent group. Null for top-level groups.
    - `created_at` string, date-time, required: Timestamp of when the group was created.
    - `updated_at` string, date-time, required: Timestamp of when the group was last updated.
    - `parent` Group (recursive)

---

[API](https://skmtc.dev/mirurobotics/apis/miru-platform-api.md) - [All operations](https://skmtc.dev/mirurobotics/apis/miru-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mirurobotics/apis/miru-platform-api/revisions/80ee5be70cc3?raw)