> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List

> List groups.

| Scope | Required |
| - | - |
| `groups:read` | Yes |


## OpenAPI

````yaml /references/platform-api/2026-10-28.yaml get /groups
openapi: 3.0.3
info:
  title: Miru Platform API
  description: The API between Miru and any external client
  version: 2026-10-28.everglades
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-release-version: 2026-10-28.everglades
  x-git-commit:
    sha: da19e118a12d7f7069f89d7781c0085522789785
    url: >-
      https://github.com/mirurobotics/openapi/commit/da19e118a12d7f7069f89d7781c0085522789785
    message: >-
      chore(stlc): seal custom-code tracking files (#381)


      Automated by the stlc generate workflow: a push-to-main or manual

      `workflow_dispatch` publish re-sealed custom code, updating the tracking

      files under `sdkgen/*/stainless/custom-code/`. Publishing targets the

      private staging repos. Safe to merge - this PR's head branch

      `stlc/seal-tracking` is skipped by the generate workflow's skip-bot

      guard in `detect`, and on merge the push loop-breaker `guard` sees only

      custom-code changes and runs no rebuild.


      <!-- codesmith:footer -->

      ---

      <a

      href="https://app.blacksmith.sh/mirurobotics/codesmith/openapi/pr/381?autoLogin=true&ref=codesmith_pr_footer"><picture><source

      media="(prefers-color-scheme: dark)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v3.svg"><source

      media="(prefers-color-scheme: light)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-light-v3.svg"><img

      alt="View with [code]smith"

      src="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v3-3x.png"

      width="162" height="28"></picture></a> <a

      href="https://backend.blacksmith.sh/track/enable-autofix?expires=1795806796&installation_model_id=425273&pr_number=381&ref=codesmith_pr_footer&repository=mirurobotics%2Fopenapi&return_to=https%3A%2F%2Fgithub.com%2Fmirurobotics%2Fopenapi%2Fpull%2F381&signature=22576ca30b7a9b5179ba686401e8539245f08cdc1682091295fe21383a37f37a"><picture><source

      media="(prefers-color-scheme: dark)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg"><source

      media="(prefers-color-scheme: light)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-light.svg"><img

      alt="Autofix with [code]smith"

      src="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark-3x.png"

      width="190" height="28"></picture></a>

      <sup>Need help on this PR? Tag <code>@codesmith</code> with what you

      need.</sup>


      <!-- codesmith:autofix:disabled -->

      <!-- /codesmith:footer -->


      Co-authored-by: stlc-sealback-bot[bot]
      <298483487+stlc-sealback-bot[bot]@users.noreply.github.com>

      Co-authored-by: Ben <ben@mirurobotics.com>
    author: stlc-sealback-bot[bot]
    branch: HEAD
    dirty: false
  x-build:
    built_at: '2026-10-28T22:21:18.805528+00:00'
servers:
  - url: https://api.mirurobotics.com/beta
    description: Miru Platform API
security:
  - ApiKeyAuth: []
paths:
  /groups:
    parameters:
      - $ref: '#/components/parameters/MiruVersion'
    get:
      tags:
        - Groups
      summary: List
      description: List groups.
      operationId: listGroups
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/group_order_bys'
        - $ref: '#/components/parameters/group_list_expansions'
        - $ref: '#/components/parameters/group_search_id'
        - $ref: '#/components/parameters/group_search_name'
        - $ref: '#/components/parameters/group_search_parent_id'
      responses:
        '200':
          description: Successfully listed the groups.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupList'
components:
  parameters:
    MiruVersion:
      name: Miru-Version
      in: header
      required: true
      schema:
        type: string
        example: 2026-10-28.everglades
      description: The API version the client was built against.
    offset:
      name: offset
      in: query
      required: false
      description: >-
        The offset of the items to return. An offset of 10 with a limit of 10
        returns items 11-20.
      schema:
        type: integer
        default: 0
        minimum: 0
        example: 0
    limit:
      name: limit
      in: query
      required: false
      description: >-
        The maximum number of items to return. A limit of 15 with an offset of 0
        returns items 1-15.
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
        example: 10
    group_order_bys:
      name: order_by
      in: query
      required: false
      style: form
      explode: false
      description: Sort order for the group results.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/GroupOrderBy'
        example:
          - created_at:desc
    group_list_expansions:
      name: expand
      in: query
      required: false
      description: Fields to expand on each group in the list.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/GroupListExpansion'
        example:
          - parent
    group_search_id:
      name: id
      in: query
      required: false
      style: form
      explode: false
      description: The group IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - grp_123
    group_search_name:
      name: name
      in: query
      required: false
      style: form
      explode: false
      description: The group names to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - production
    group_search_parent_id:
      name: parent_id
      in: query
      required: false
      style: form
      explode: false
      description: The parent group IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - grp_456
  schemas:
    GroupList:
      title: Group List
      allOf:
        - $ref: '#/components/schemas/PaginatedList'
        - type: object
          required:
            - data
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Group'
              description: The list of groups.
    GroupOrderBy:
      type: string
      enum:
        - id:asc
        - id:desc
        - created_at:asc
        - created_at:desc
        - updated_at:asc
        - updated_at:desc
        - name:asc
        - name:desc
      x-enum-varnames:
        - GROUP_ORDER_BY_ID_ASC
        - GROUP_ORDER_BY_ID_DESC
        - GROUP_ORDER_BY_CREATED_AT_ASC
        - GROUP_ORDER_BY_CREATED_AT_DESC
        - GROUP_ORDER_BY_UPDATED_AT_ASC
        - GROUP_ORDER_BY_UPDATED_AT_DESC
        - GROUP_ORDER_BY_NAME_ASC
        - GROUP_ORDER_BY_NAME_DESC
      default: created_at:desc
    GroupListExpansion:
      type: string
      enum:
        - total_count
        - parent
      x-enum-varnames:
        - GROUP_LIST_EXPAND_TOTAL_COUNT
        - GROUP_LIST_EXPAND_PARENT
    PaginatedList:
      title: Paginated List
      type: object
      required:
        - object
        - limit
        - offset
        - has_more
      properties:
        object:
          type: string
          enum:
            - list
          example: list
          x-stainless-const: true
          description: The object type, which is always `list`.
        total_count:
          type: integer
          format: int64
          description: >-
            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:
          type: integer
          description: >-
            The maximum number of items to return. A limit of 15 with an offset
            of 0 returns items 1-15.
          default: 10
          minimum: 1
          maximum: 100
        offset:
          type: integer
          description: >-
            The offset of the items to return. An offset of 10 with a limit of
            10 returns items 11-20.
          default: 0
          minimum: 0
        has_more:
          type: boolean
          description: >-
            True if there are more items in the list to return. False if there
            are no more items to return.
          example: false
    Group:
      title: Group
      allOf:
        - $ref: '#/components/schemas/BaseGroup'
        - type: object
          properties:
            parent:
              allOf:
                - $ref: '#/components/schemas/Group'
              nullable: true
              description: >-
                The parent group. Null for top-level groups. Expand using
                `expand=parent` in the query string.
      example:
        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'
    BaseGroup:
      title: Base Group
      type: object
      required:
        - object
        - id
        - name
        - parent_id
        - created_at
        - updated_at
      properties:
        object:
          type: string
          enum:
            - group
          example: group
          x-stainless-const: true
          description: The object type, which is always `group`.
        id:
          type: string
          example: grp_123
          description: ID of the group.
        name:
          type: string
          example: production
          description: Name of the group.
        parent_id:
          type: string
          nullable: true
          example: grp_456
          description: ID of the parent group. Null for top-level groups.
        created_at:
          type: string
          format: date-time
          example: '2026-01-01T00:00:00Z'
          description: Timestamp of when the group was created.
        updated_at:
          type: string
          format: date-time
          example: '2026-01-01T00:00:00Z'
          description: Timestamp of when the group was last updated.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: The API key to use for authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.