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

# Get user group by ID

> Get a specific user group by ID. See [User Groups](https://docs.galtea.ai/concepts/user-group).

> [!WARNING]
>
> You are reading the docs of Galtea 5.17. [Read this page in the latest version](https://docs.galtea.ai/api-reference/user-groups/get-user-group-by-id.md).


## OpenAPI

````yaml /v5.17/openapi.json get /userGroups/{id}
openapi: 3.0.0
info:
  version: 1.0.0
  title: Product Management Service API
  description: API documentation for Product Management Service
  contact:
    name: Galtea AI
servers:
  - url: https://api.galtea.ai
security:
  - bearerAuth: []
tags: []
externalDocs:
  description: Galtea Platform Documentation
  url: https://docs.galtea.ai
paths:
  /userGroups/{id}:
    get:
      tags:
        - user-groups
      summary: Get user group by ID
      description: >-
        Get a specific user group by ID. See [User
        Groups](https://docs.galtea.ai/concepts/user-group).
      operationId: getUserGroupById
      parameters:
        - schema:
            type: string
            description: User group ID
            example: ug_123
          required: true
          description: User group ID
          name: id
          in: path
      responses:
        '200':
          description: User group retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The caller may not read this user group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    UserGroup:
      type: object
      properties:
        id:
          type: string
          example: ug_123
        organizationId:
          type: string
          example: org_123
        name:
          type: string
          example: QA Team
        type:
          type: string
          enum:
            - EVALUATOR
          example: EVALUATOR
        description:
          type: string
          nullable: true
          example: Quality assurance team
        createdAt:
          type: string
          format: date-time
        userIds:
          type: array
          items:
            type: string
          example:
            - user_123
        metricIds:
          type: array
          items:
            type: string
          description: >-
            Metrics linked to this group. A MEMBER caller sees only the linked
            metrics it can read.
          example:
            - metric_123
        productIds:
          type: array
          items:
            type: string
          description: >-
            Products linked to this group. A MEMBER caller sees only the linked
            products it can read.
          example:
            - product_123
        allProducts:
          type: boolean
          description: >-
            Grants this group every product of its organization, current and
            future. Wins over explicit product links while set.
          example: false
        permissionPreset:
          type: string
          nullable: true
          enum:
            - EDITOR
            - HUMAN_EVALUATOR
            - READER
            - null
          description: >-
            The preset the group follows; when the preset changes, the group's
            permissions change with it. Null means the group holds its own list
            in `permissions`.
          example: READER
        permissions:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            The permissions the group grants, each written `entity.action`,
            sorted. A product entry applies to the products the group reaches; a
            metric, model or comment entry applies across the organization. For
            a group that follows a preset, this is the preset's current list.
            Null means the group follows the EDITOR preset: it grants every
            permission its members role allows. An empty list grants nothing. A
            user in several groups may do a product action when any group that
            reaches the product lists it, and an organization action when any
            group lists it. The role of the user still limits what a list can
            grant.
          example:
            - analytics.read
            - metric.read
            - product.read
        deletedAt:
          type: string
          format: date-time
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          example: Error type
        message:
          type: string
          example: Error message description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authorization. Pass your API key in the Authorization header as
        a Bearer token. Both new (`gsk_*`) and legacy (`gsk-`) API keys are
        accepted, e.g. `Authorization: Bearer gsk_...` or `Authorization: Bearer
        gsk-...`.

````

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