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

# List groups

> The agency's member groups.



## OpenAPI

````yaml /api-reference/management-openapi.yaml get /{agency_uid}/user_groups
openapi: 3.0.3
info:
  title: Kenekt Management API
  version: v1
  description: >-
    Manage an agency's stock and team: projects, lots, packages, designs,
    facades, developments, inclusions, commission rates, members and groups.


    Authenticate with an API key from a staff or admin member's account page,
    sent as `Authorization: Bearer YOUR_API_KEY`. A key works on every agency
    where its holder has a staff role; put that agency's public id in the path.


    This API is evolving: endpoints and fields may change without notice.
servers:
  - url: https://app.kenekt.com.au/v1
security: []
tags:
  - name: Stock / Projects
    description: 'Projects: a stage or release inside a development, grouping the lots.'
  - name: Stock / Lots
    description: Lots, their status, and moves between projects.
  - name: Stock / Packages
    description: 'Property packages: the sellable pairing of a lot with a design and facade.'
  - name: Stock / Designs
    description: Designs, their price tiers, rooms, and linked facades.
  - name: Stock / Facades
    description: Facades offered against designs.
  - name: Stock / Developments
    description: 'Developments: the estate or masterplanned community projects sit inside.'
  - name: Stock / Inclusions
    description: Inclusion packages, their items, and what they are linked to.
  - name: Stock / Commission Rates
    description: Commission rates and what they are applied to.
  - name: Stock / Attachments
    description: Photos and documents on any stock resource.
  - name: Stock / Library
    description: >-
      The whole library (designs, price tiers, facades, inclusions) as flat
      export rows.
  - name: Team / Members
    description: Members of the agency, their API keys, documents, and inclusions.
  - name: Team / Groups
    description: User groups and their memberships.
  - name: Team / Engagement
    description: >-
      Agent engagement: who is active, who has gone quiet, what they view and
      search for.
  - name: Agency
    description: The agency record and its settings.
  - name: Agency / Documents
    description: Agency-level documents.
  - name: EOIs
    description: Expressions of interest, purchasers, and sighted ID capture.
paths:
  /{agency_uid}/user_groups:
    get:
      tags:
        - Team / Groups
      summary: List groups
      description: The agency's member groups.
      parameters:
        - name: agency_uid
          in: path
          required: true
          schema:
            type: string
          description: Agency public_uid
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_groups:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        owner_uid:
                          type: string
                        member_count:
                          type: integer
                        members:
                          type: array
                          items:
                            type: object
                            properties:
                              public_uid:
                                type: string
                                nullable: true
                              name:
                                type: string
                            required:
                              - public_uid
                              - name
                      required:
                        - id
                        - name
                        - owner_uid
                        - member_count
                        - members
                required:
                  - user_groups
              example:
                user_groups:
                  - id: 964119498
                    name: Sales Team
                    owner_uid: USR-DEFAULT-001
                    member_count: 2
                    members:
                      - public_uid: USR-USER1-001
                        name: User One
                      - public_uid: USR-USER2-001
                        name: User Two
                  - id: 113722440
                    name: Marketing Team
                    owner_uid: USR-USER1-001
                    member_count: 1
                    members:
                      - public_uid: null
                        name: BDM User
      security:
        - bearer_auth: []
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: Token

````

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