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

# Get Groups

> Retrieve all groups (teams) that the authenticated user has administrative access to. Only returns groups where the user is designated as an administrator.



## OpenAPI

````yaml https://external-api.mileiq.com/openapi.json get /v1/groups
openapi: 3.1.0
info:
  title: MileIQ External API
  description: External API for integrating with the MileIQ Platform.
  termsOfService: https://mileiq.com/terms
  contact:
    name: MileIQ
    url: https://developer.mileiq.com/
    email: support@mileiq.com
  version: 1.4.0
servers:
  - url: https://external-api.mileiq.com
    description: MileIQ External API
security: []
paths:
  /v1/groups:
    get:
      tags:
        - groups
      summary: Get Groups
      description: >-
        Retrieve all groups (teams) that the authenticated user has
        administrative access to. Only returns groups where the user is
        designated as an administrator.
      operationId: get_groups
      parameters:
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
            title: Authorization
      responses:
        '200':
          description: >-
            Successfully retrieved list of accessible groups. Returns an array
            of group objects with their details including members, metadata, and
            display information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListResponse'
        '401':
          description: Authentication failed. Invalid or missing authorization token.
        '403':
          description: >-
            Insufficient permissions. User does not have the required
            'groups_read' scope or is not authenticated.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded. Maximum 30 requests per minute allowed.
        '500':
          description: >-
            Internal server error. An unexpected error occurred while processing
            the request.
components:
  schemas:
    GroupListResponse:
      properties:
        resources:
          items:
            $ref: '#/components/schemas/GroupSchema'
          type: array
          title: Resources
          description: >-
            Array of group objects containing detailed information about each
            accessible group, including members, roles, and metadata
      type: object
      required:
        - resources
      title: GroupListResponse
      description: >-
        Response model containing a collection of groups with their complete
        information and member details
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GroupSchema:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: >-
            Unique identifier for the group - used for API operations and
            internal references
        display_name:
          type: string
          title: Display Name
          description: >-
            User-friendly name of the group as shown throughout the application
            interface
        members:
          anyOf:
            - items:
                $ref: '#/components/schemas/GroupMember'
              type: array
            - type: 'null'
          title: Members
          description: >-
            List of all members belonging to this group, including their roles
            and permissions
        meta:
          anyOf:
            - $ref: '#/components/schemas/Meta'
            - type: 'null'
          description: >-
            Additional metadata about the group including creation time, last
            modification, and resource location
      type: object
      required:
        - id
        - display_name
      title: GroupSchema
      description: >-
        Represents a group (team) entity with complete information about its
        structure, members, and metadata
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    GroupMember:
      properties:
        value:
          type: string
          title: Value
          description: >-
            Unique identifier for the group member (typically the user's Parse
            ID)
        display:
          anyOf:
            - type: string
            - type: 'null'
          title: Display
          description: >-
            Human-readable name of the member as shown in the application
            interface
        is_admin:
          type: boolean
          title: Is Admin
          description: >-
            Boolean indicating whether this member has administrative privileges
            for the group
        is_driver:
          type: boolean
          title: Is Driver
          description: >-
            Boolean indicating whether this member is designated as a driver who
            can submit drives to the group
      type: object
      required:
        - value
        - display
        - is_admin
        - is_driver
      title: GroupMember
      description: >-
        Represents a member of a group with their role assignments and display
        information
    Meta:
      properties:
        resourceType:
          type: string
          title: Resourcetype
          description: >-
            Type of resource (user/group) - identifies the kind of entity this
            metadata belongs to
        created:
          type: string
          format: date-time
          title: Created
          description: >-
            Timestamp when the resource was originally created, in ISO 8601
            format
        lastModified:
          type: string
          format: date-time
          title: Lastmodified
          description: >-
            Timestamp when the resource was last updated or modified, in ISO
            8601 format
        location:
          type: string
          title: Location
          description: Canonical URL where this resource can be accessed via the API
      type: object
      required:
        - resourceType
        - created
        - lastModified
        - location
      title: Meta
      description: >-
        Generic metadata providing audit trail and resource identification
        information

````