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

# List user groups

> Returns a list of user groups, sorted by creation time.



## OpenAPI

````yaml /api/openapi.yaml get /scim/v2/groups
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: AI
    description: AI-powered query generation
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Labels
    description: >
      Manage labels in an organization. Labels can be applied to documents and
      folders to help organize and categorize content.


      **Label types:**

      - **Basic labels**: Can be created and managed by any user

      - **Verified labels**: Indicate curated or officially sanctioned content.
      Admin-only.

      - **Homepage labels**: Appear on the organization homepage. Admin-only.
  - name: Folders
    description: Create and organize content folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /scim/v2/groups:
    get:
      tags:
        - User groups
      summary: List user groups
      description: Returns a list of user groups, sorted by creation time.
      operationId: listUserGroups
      parameters:
        - name: count
          in: query
          schema:
            type: integer
            default: 100
          description: The number of groups to return
          example: 50
        - name: startIndex
          in: query
          schema:
            type: integer
            default: 1
          description: >-
            An integer index that determines the starting point of the sorted
            result list
          example: 1
      responses:
        '200':
          description: List of user groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  Resources:
                    type: array
                    description: The list of user groups
                    items:
                      $ref: '#/components/schemas/ScimGroup'
                  schemas:
                    type: array
                    description: SCIM schema information for the response
                    items:
                      type: string
                  itemsPerPage:
                    type: integer
                    description: The number of groups returned in the current page
                  startIndex:
                    type: integer
                    description: The starting index of the current page in the result set
                  totalResults:
                    type: integer
                    description: The total number of groups matching the query
              example:
                Resources:
                  - displayName: Blob Sales
                    id: mEhXj6ZI
                    meta:
                      created: '2024-08-29T20:33:36.626Z'
                      lastModified: '2024-08-29T20:33:36.626Z'
                      resourceType: Group
                    schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                    members:
                      - display: blob.ross@blobsrus.co
                        value: 9e8719d9-276a-4964-9395-a493189a247c
                itemsPerPage: 1
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                startIndex: 1
                totalResults: 1
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - orgApiKey: []
components:
  schemas:
    ScimGroup:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the group
        displayName:
          type: string
          description: The name of the group
        members:
          type: array
          description: The list of users in the group
          items:
            type: object
            properties:
              value:
                type: string
                description: The user's unique identifier
              display:
                type: string
                description: The user's email address
        meta:
          type: object
          description: Metadata about the group resource
          properties:
            resourceType:
              type: string
              example: Group
              description: The type of resource. This will be `Group`.
            created:
              type: string
              format: date-time
              description: The time the group was created
            lastModified:
              type: string
              format: date-time
              description: The time the group was last updated
        schemas:
          type: array
          description: SCIM schema information for the group
          items:
            type: string
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#personal-access-tokens-pat).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````