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

# List device groups

> List, retrieve, create, update, and delete device groups.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/device-groups/
openapi: 3.0.3
info:
  title: Fleet Manager API
  version: 1.0.0
  description: API for the Nscale Fleet Manager
servers: []
security: []
paths:
  /api/v1/device-groups/:
    get:
      tags:
        - Device Groups
      summary: List device groups
      description: List, retrieve, create, update, and delete device groups.
      operationId: api_v1_device_groups_list
      parameters:
        - name: annotation_eq
          required: false
          in: query
          description: >-
            Filter by annotation key=value pairs (AND semantics). Use
            annotation_eq[key]=value.
          style: deepObject
          explode: true
          schema:
            type: object
            additionalProperties:
              type: string
        - name: annotation_has
          required: false
          in: query
          description: Filter by annotation key existence (comma-separated, AND semantics).
          schema:
            type: string
        - in: query
          name: device_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
            maximum: 500
            minimum: 1
        - in: query
          name: name
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - in: query
          name: site_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - name: tag
          required: false
          in: query
          description: Filter by tags (comma-separated, OR semantics).
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDeviceGroupList'
          description: ''
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - device-group:read
        - cookieAuth: []
components:
  schemas:
    PaginatedDeviceGroupList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/DeviceGroup'
    ErrorResponse:
      type: object
      description: >-
        Uniform error body for every 4xx/5xx response. `detail` is a
        human-readable message, always present, safe to display to end users.
        `code` is the machine-readable identifier. `field_errors` lists
        per-input-field validation messages and is empty for non-field errors
        (auth, permission, not-found, conflict, server).
      required:
        - detail
        - code
        - field_errors
      properties:
        detail:
          type: string
        code:
          $ref: '#/components/schemas/ErrorCodeEnum'
        field_errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    DeviceGroup:
      type: object
      description: Serializer for DeviceGroup model (create, read, update).
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        slug:
          type: string
          maxLength: 255
          pattern: ^[-a-zA-Z0-9_]+$
        description:
          type: string
        site:
          type: string
          format: uuid
        site_name:
          type: string
          readOnly: true
        device_ids:
          type: array
          items:
            type: string
            format: uuid
          writeOnly: true
          description: List of device UUIDs to include in the group.
          maxItems: 1000
        devices:
          type: array
          items:
            type: string
            format: uuid
          readOnly: true
        device_names:
          type: array
          items:
            type: string
          readOnly: true
        device_count:
          type: integer
          readOnly: true
        annotations:
          type: object
          additionalProperties:
            type: string
          description: >-
            Key-value annotations. Keys must start with a lowercase letter and
            contain only lowercase alphanumeric segments joined by hyphens or
            underscores (e.g. 'org-id', 'gpu_ready').
        tags:
          type: array
          items:
            type: string
          description: >-
            Tags for the resource. Must start with a lowercase letter and
            contain only lowercase alphanumeric segments joined by hyphens or
            underscores (e.g. 'gpu-ready', 'needs_review'). Stored deduplicated
            and sorted.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        links:
          allOf:
            - $ref: '#/components/schemas/DeviceGroupLinks'
          readOnly: true
      required:
        - created_at
        - device_count
        - device_names
        - devices
        - id
        - links
        - name
        - site
        - site_name
        - slug
        - updated_at
    ErrorCodeEnum:
      type: string
      description: >-
        Stable machine-readable error identifier. New members may be added
        within this API version; clients must tolerate unknown values.
      enum:
        - error
        - invalid
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - conflict
        - enrollment_infrastructure_reference_pending
        - enrollment_infrastructure_reference_changed
        - unprocessable_entity
        - throttled
        - service_unavailable
    FieldError:
      type: object
      description: One input field's validation messages.
      required:
        - field
        - messages
      properties:
        field:
          type: string
          description: >-
            Dotted path to the offending input field, or to the collection row
            when the whole row is invalid (e.g. `filters.end_date`,
            `memberships.0.role`, `memberships.0`).
        messages:
          type: array
          minItems: 1
          items:
            type: string
    DeviceGroupLinks:
      type: object
      description: Serializer for device group links.
      properties:
        self:
          type: string
          format: uri
          readOnly: true
        collection:
          type: string
          format: uri
          readOnly: true
        site:
          type: string
          format: uri
          readOnly: true
        devices:
          type: string
          format: uri
          readOnly: true
      required:
        - collection
        - devices
        - self
        - site
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

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