MImirurobotics
Groups

List

List groups.

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

Query parameters

offsetinteger

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

limitinteger
Example:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

order_byGroupOrderBy[]

Sort order for the group results.

[
  "created_at:desc"
]
expandGroupListExpansion[]

Fields to expand on each group in the list.

[
  "parent"
]
idstring[]

The group IDs to filter by.

[
  "grp_123"
]
namestring[]

The group names to filter by.

[
  "production"
]
parent_idstring[]

The parent group IDs to filter by.

[
  "grp_456"
]

Response

Successfully listed the groups.

object'list' required

The object type, which is always list.

total_countinteger

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.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "group",
      "id": "grp_789",
      "name": "line-3",
      "parent_id": "grp_456",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.