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

# Browse Group Definitions

> A `GET` to the `/groups/definitions` endpoint allows your application to retrieve all group definition records.



## OpenAPI

````yaml get /v3/groups/definitions
openapi: 3.1.0
info:
  title: Omneo
  version: 0.0.1
servers:
  - url: https://api.{tenant}.getomneo.com/api
    variables:
      tenant:
        default: example
security: []
paths:
  /v3/groups/definitions:
    get:
      tags:
        - Group Definition
      summary: Browse Group Definitions
      description: >-
        A `GET` to the `/groups/definitions` endpoint allows your application to
        retrieve all group definition records.
      operationId: groups.definitions.index
      parameters:
        - name: page[size]
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Array of `GroupDefinition`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/GroupDefinition'
                required:
                  - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '403':
          $ref: '#/components/responses/AuthorizationException'
components:
  schemas:
    GroupDefinition:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        handle:
          type: string
        type:
          type: string
        source_type:
          type:
            - string
            - 'null'
        source_id:
          type:
            - integer
            - 'null'
        query:
          type:
            - string
            - 'null'
        query_type:
          type:
            - string
            - 'null'
        arguments:
          type:
            - array
            - 'null'
          items: {}
        period:
          type:
            - integer
            - 'null'
        period_type:
          type:
            - string
            - 'null'
        absolute_expiry:
          type:
            - string
            - 'null'
        refresh_period:
          type:
            - integer
            - 'null'
        refresh_period_type:
          type:
            - string
            - 'null'
        refresh_absolute_expiry:
          type:
            - string
            - 'null'
        last_refreshed_at:
          type: string
        next_refresh_at:
          type: string
        refresh_status:
          type:
            - string
            - 'null'
        refresh_error:
          type:
            - string
            - 'null'
        short_description:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        owner_profile_id:
          type:
            - string
            - 'null'
        meta:
          type:
            - array
            - 'null'
          items: {}
        is_published:
          type: boolean
        is_active:
          type: boolean
        is_archived:
          type: boolean
        current_member_count:
          type: integer
        rules:
          type: array
          description: |-
            Inclusion/exclusion rules (with their effective, definition-
            resolved values). Always loaded by the group-definition endpoints
            regardless of type, so the shape is consistent — static/favourite
            groups carry an empty array.
          items:
            $ref: '#/components/schemas/GroupRule'
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - name
        - handle
        - type
        - source_type
        - source_id
        - query
        - query_type
        - arguments
        - period
        - period_type
        - absolute_expiry
        - refresh_period
        - refresh_period_type
        - refresh_absolute_expiry
        - last_refreshed_at
        - next_refresh_at
        - refresh_status
        - refresh_error
        - short_description
        - description
        - owner_profile_id
        - meta
        - is_published
        - is_active
        - is_archived
        - created_at
        - updated_at
      title: GroupDefinition
    GroupRule:
      type: object
      properties:
        id:
          type: integer
        group_definition_id:
          type: integer
        group_rule_definition_id:
          type:
            - integer
            - 'null'
        type:
          type: string
        name:
          type:
            - string
            - 'null'
        arguments:
          type:
            - array
            - 'null'
          items: {}
        sort_order:
          type: integer
        is_active:
          type: boolean
        meta:
          type:
            - array
            - 'null'
          items: {}
        effective:
          type: object
          description: |-
            Resolved values actually used for evaluation — evaluator/rule come
            from the referenced definition; arguments are definition defaults
            merged with this instance's overrides.
          properties:
            handle:
              type: string
            evaluator:
              type:
                - string
                - 'null'
            rule:
              type:
                - object
                - 'null'
              additionalProperties: {}
            name:
              type:
                - string
                - 'null'
            arguments:
              type: array
              items: {}
          required:
            - handle
            - evaluator
            - rule
            - name
            - arguments
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - group_definition_id
        - group_rule_definition_id
        - type
        - name
        - arguments
        - sort_order
        - is_active
        - meta
        - effective
        - created_at
        - updated_at
      title: GroupRule
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message

````