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

# List groups

> Returns groups in the workspace. Use `search` to resolve your own identifier to a `group_id`: it matches both the group name and the `data_id` you assigned, partially — searching `acme` also returns `acme-eu`, so compare `data_id` in the response.



## OpenAPI

````yaml /docs/api/openapi-v2.yaml get /groups
openapi: 3.1.0
info:
  title: Sleekplan API v2
  version: '2.0'
  description: >-
    The `/v2` namespace sits alongside the existing [`/v1`
    API](/docs/api/overview) — it is not a replacement. The same API key
    authenticates both.


    `/v2` accepts **Bearer tokens only**, and carries no workspace ID in the URL
    because the key identifies the workspace. Changes are additive: fields and
    endpoints are added, never removed or renamed.


    See [API v2](/docs/api/v2) for authentication, the error keys, and the rate
    limit.
servers:
  - url: https://api.sleekplan.com/v2
    description: API Version 2
security:
  - BearerAuth: []
tags:
  - name: Group
    description: B2B groups — companies, accounts or teams — and their members.
  - name: Document
    description: >-
      The thinking behind your feedback — a plan, a spec, research, or the
      record of a decision.
paths:
  /groups:
    get:
      tags:
        - Group
      summary: List groups
      description: >-
        Returns groups in the workspace. Use `search` to resolve your own
        identifier to a `group_id`: it matches both the group name and the
        `data_id` you assigned, partially — searching `acme` also returns
        `acme-eu`, so compare `data_id` in the response.
      operationId: v2-list-groups
      parameters:
        - in: query
          name: search
          schema:
            type: string
          description: Partial match across the group name and your own identifier.
        - in: query
          name: type
          schema:
            type: string
          description: Filter by group type.
        - in: query
          name: user_id
          schema:
            type: integer
          description: Only groups this end-user belongs to.
        - in: query
          name: sort
          schema:
            type: string
            default: updated
            enum:
              - name
              - type
              - weight
              - mrr
              - created
              - updated
              - stats_users
              - stats_feedback
              - stats_votes
              - stats_comments
              - stats_satisfaction
              - stats_promoter
              - stats_active
        - in: query
          name: sort_dir
          schema:
            type: string
            default: desc
            enum:
              - asc
              - desc
        - in: query
          name: page
          schema:
            type: integer
            default: 0
        - in: query
          name: per_page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/Group'
                      has_more:
                        type: boolean
                      page:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Group:
      type: object
      description: >-
        The published shape of a group. Fields are added over time and never
        removed — ignore any you do not recognise.
      properties:
        group_id:
          type: integer
          description: The Sleekplan ID. Use it in every other call.
        data_id:
          type: string
          description: Your own identifier, set on create or by Single Sign-On.
        name:
          type: string
        type:
          type: string
          example: company
        weight:
          type: integer
        mrr:
          type: integer
        meta:
          type: object
          description: Your custom key/value data.
        stats:
          type: object
          description: Maintained on a schedule; may lag a change by up to an hour.
          properties:
            users:
              type: integer
            feedback:
              type: integer
            votes:
              type: integer
            comments:
              type: integer
            satisfaction:
              type: number
              description: Average CSAT, 0–5. Non-responders are excluded.
            promoter:
              type: number
              description: Average NPS, 0–10. Non-responders are excluded.
            active:
              type:
                - string
                - 'null'
              description: When a member was last active. `null` if never.
        created:
          type: string
          example: '2026-09-17 14:02:11'
        updated:
          type: string
          example: '2026-09-17 14:05:44'
    Error:
      type: object
      properties:
        status:
          type: string
          example: error
        data:
          type: object
          properties:
            key:
              type: string
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or non-API-key credential
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key's user lacks the permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Over 300 requests in 60 seconds
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer YOUR_API_KEY`. /v2 accepts no other method.'

````