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

# List user groups

> Pages through the workspace's user groups (Settings > Team > Groups), in the order they were made, with each one's member count. Includes the groups the app keeps for each role and department. Read one by id for its members.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/groups
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/groups:
    get:
      tags:
        - groups
      summary: List user groups
      description: >-
        Pages through the workspace's user groups (Settings > Team > Groups), in
        the order they were made, with each one's member count. Includes the
        groups the app keeps for each role and department. Read one by id for
        its members.
      operationId: groups_list
      parameters:
        - description: >-
            Only groups whose name, as `name` returns it, contains this (any
            case)
          in: query
          name: search
          required: false
          schema:
            anyOf:
              - maxLength: 200
                minLength: 1
                type: string
              - type: 'null'
            default: null
        - in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            type: integer
        - description: '`next_cursor` from the previous page'
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_Group_'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    Page_Group_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Group'
          title: Data
          type: array
        has_more:
          default: false
          title: Has More
          type: boolean
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      required:
        - data
      title: Page[Group]
      type: object
    Group:
      properties:
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the group was made
          title: Created At
        id:
          description: The group's id
          title: Id
          type: string
        member_count:
          description: The users in the group
          title: Member Count
          type: integer
        name:
          description: The group's name, as Settings > Team > Groups shows it
          title: Name
          type: string
        type:
          description: >-
            custom: a group someone made. role or department: the group the app
            keeps for every user with that role or department on their Team page
            record, named after it
          enum:
            - custom
            - role
            - department
          title: Type
          type: string
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the group's name last changed; adding or removing a member
            leaves it as it was
          title: Updated At
      required:
        - id
        - name
        - type
        - member_count
        - created_at
        - updated_at
      title: Group
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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