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

# List groups

> Returns a paginated list of groups visible to the authenticated user. The list can be filtered by membership mode, group type and sorting method.



## OpenAPI

````yaml /openapi.yaml get /groups
openapi: 3.0.0
info:
  title: Ziik API
  version: '1.0'
servers: []
security: []
tags:
  - name: Auth
    description: Auth
  - name: Posts
    description: Posts
  - name: Counters
    description: Counters
  - name: Groups
    description: Groups
  - name: Languages
    description: Languages
  - name: Timezones
    description: Timezones
  - name: Units
    description: Units
  - name: User unit memberships
    description: User unit memberships
  - name: Users
    description: Users
  - name: User types
    description: User types
  - name: Conversations
    description: Conversations
paths:
  /groups:
    get:
      tags:
        - Groups
      summary: List groups
      description: >-
        Returns a paginated list of groups visible to the authenticated user.
        The list can be filtered by membership mode, group type and sorting
        method.
      operationId: bef7bc6436ad2524e81253beb2657bf9
      parameters:
        - name: mode
          in: query
          description: >-
            Filter groups by membership mode. `member` lists groups the user is
            a member of, `available` lists joinable public groups, and
            `can_publish` lists groups where the user is allowed to publish.
          required: false
          schema:
            type: string
            enum:
              - member
              - available
              - can_publish
        - name: type
          in: query
          description: Filter by group visibility type.
          required: false
          schema:
            type: string
            enum:
              - public
              - private
        - name: sort
          in: query
          description: >-
            Sorting method for the group list. `activity` sorts by most recently
            updated, `name` sorts alphabetically.
          required: false
          schema:
            type: string
            enum:
              - activity
              - name
        - name: limit
          in: query
          description: Maximum number of groups per page (1–100). Defaults to 50.
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
      responses:
        '200':
          description: Paginated list of groups.
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                type: object
components:
  schemas:
    Group:
      properties:
        id:
          type: integer
          example: 1
        content_type:
          type: string
          example: group
        name:
          type: string
          example: Team Alpha
        description:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - public
            - private
          example: public
        mute_rule:
          description: Mute rule/blacklist ID or null
          type: integer
          nullable: true
        has_unread_notifications:
          type: boolean
        only_admin_publish:
          type: integer
        post_comments_enabled_default:
          type: boolean
        member:
          description: 'Membership role: false, "member", or "admin"'
          type: string
          nullable: true
        image:
          description: Group image when loaded
          type: object
          nullable: true
        auto:
          description: Auto-add units/user types when loaded
          type: object
          nullable: true
        url:
          type: string
          example: api/groups/1
        permissions:
          properties:
            member:
              type: string
              nullable: true
            edit:
              type: boolean
            delete:
              type: boolean
          type: object
        publish:
          properties:
            updated_at:
              description: Unix timestamp
              type: integer
          type: object
        membership:
          properties:
            auto:
              type: boolean
          type: object
          nullable: true
        stats:
          properties:
            active:
              type: integer
          type: object
          nullable: true
      type: object

````