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

# List

> List user groups



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /user-groups
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /user-groups:
    get:
      tags:
        - UserGroups
      summary: List
      description: List user groups
      operationId: getUserGroups
      responses:
        '200':
          description: All groups
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroup'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    UserGroup:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        name:
          type: string
        color:
          type: string
          default: ''
        icon:
          type: string
          default: ''
        description:
          type: string
          default: ''
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/FeaturePermission'
          default: []
          description: Feature permissions granted to members
        pools:
          type:
            - array
            - 'null'
          items:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          default: null
        hidden_pools:
          type:
            - array
            - 'null'
          items:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          default: null
        submit:
          anyOf:
            - $ref: '#/components/schemas/SubmitPolicy'
            - type: 'null'
          default: null
      required:
        - id
        - name
        - color
        - icon
        - description
        - permissions
        - pools
        - hidden_pools
        - submit
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    FeaturePermission:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/FeatureId'
        level:
          $ref: '#/components/schemas/PermissionLevel'
        enabled:
          type: boolean
      required:
        - id
      additionalProperties: {}
    SubmitPolicy:
      type: object
      properties:
        priority:
          $ref: '#/components/schemas/SubmitPropPolicy'
        node_limit:
          $ref: '#/components/schemas/SubmitPropPolicy'
        run_on_each_node:
          $ref: '#/components/schemas/SubmitPropPolicy'
    FeatureId:
      type: string
      enum:
        - job.create
        - job.start
        - JobStart
        - job.stop
        - JobStop
        - job.finish
        - JobFinish
        - job.reset
        - JobReset
        - job.delete
        - JobDelete
        - job.update
        - JobUpdate
        - job.archive.create
        - JobArchiveCreate
        - job.archive.restore
        - JobArchiveRestore
        - job.archive.delete
        - JobArchiveDelete
        - job.view
        - job.output
        - node.update
        - NodeUpdate
        - node.restart
        - NodeRestart
        - run.script
        - RunScript
        - node.shutdown
        - NodeShutdown
        - node.suspend
        - NodeSuspend
        - node.reserve
        - NodeReserve
        - node.resume
        - NodeResume
        - node.wakeup
        - NodeWakeup
        - node.delete
        - NodeDelete
        - node.finish
        - NodeFinish
        - node.pool.change
        - NodePoolChange
        - node.mode.change
        - node.spawner.start
        - node.spawner.stop
        - node.affinity
        - node.rdp
        - workstation.view
        - node.view
        - software
        - statistics
        - scheduler.view
        - scheduler.edit
        - sanity.edit
        - errorcatalog.edit
        - report.create
        - system.idle
        - SystemIdle
        - system.maintenance
        - SystemMaintenance
        - system.settings
        - apikey.manage
        - template.author
        - ai.compose
        - ai.clients
        - system.updates
        - cloud.view
        - cloud.operate
        - cloud.manage
        - system.view
    PermissionLevel:
      type: string
      enum:
        - none
        - user
        - group
        - everyone
    SubmitPropPolicy:
      type: object
      properties:
        max:
          type:
            - integer
            - 'null'
          minimum: 0
          maximum: 10000
        locked:
          type: boolean
        hidden:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

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