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

> ## Agent Instructions
> Flowsign is one word with a lowercase s.
> The REST API base URL is https://my.flowsign.app and every endpoint lives under /api/v1.
> When answering API questions, cite the HTTP method and endpoint path.
> API access needs the Enterprise plan and an API key with the API access permission.

# List signing groups

> Returns every signing group in the workspace with its member count. Requires canManageSigningGroups.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/signing-groups
openapi: 3.0.3
info:
  title: Flowsign API
  version: 1.0.0
  description: >-
    Public v1 API for Flowsign. Every endpoint is authenticated with a Bearer
    API key (prefix `fsk_`). Errors use `{ error, details? }`; success responses
    wrap payload data as `{ data }`.


    An organisation is divided into workspaces. A key is issued for one
    workspace and acts there on every request (see `GET /api/v1/workspaces`);
    `X-Workspace-Id` is optional and may only name that workspace. Packages,
    templates, contacts and members are scoped to the key's workspace.
servers:
  - url: https://my.flowsign.app
    description: Production
security:
  - ApiKey: []
paths:
  /api/v1/signing-groups:
    get:
      tags:
        - Signing groups
      summary: List signing groups
      description: >-
        Returns every signing group in the workspace with its member count.
        Requires canManageSigningGroups.
      operationId: getSigning-groups
      parameters:
        - schema:
            type: string
            description: >-
              The workspace the key was issued for, as returned by `GET
              /api/v1/workspaces`. Optional: omitting it acts in the key's
              workspace, and any other id is rejected with 401.
          required: false
          name: x-workspace-id
          in: header
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Signing group id.
                          example: cmg1hd3x10002v8p9f6r8bt4n
                        name:
                          type: string
                          description: Group name, unique within the workspace.
                          example: Finance approvers
                        description:
                          type: string
                          nullable: true
                          description: Free-text description. Null when none is set.
                          example: >-
                            Anyone in Finance who can countersign supplier
                            contracts
                        memberCount:
                          type: integer
                          minimum: 0
                          description: >-
                            Number of members. A group with 0 members cannot be
                            used as a recipient.
                          example: 3
                        createdAt:
                          type: string
                          description: When the group was created (ISO 8601).
                          example: '2026-07-21T22:10:45.000Z'
                        updatedAt:
                          type: string
                          description: >-
                            When the group's name or description last changed
                            (ISO 8601).
                          example: '2026-09-08T03:27:19.000Z'
                      required:
                        - id
                        - name
                        - description
                        - memberCount
                        - createdAt
                        - updatedAt
                    description: Every signing group in the workspace, sorted by name.
                required:
                  - data
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Caller's plan does not include this feature (publicApi / webhooks)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key present but caller lacks the required permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Request failed schema validation; details keyed by field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded; see `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong, in plain words.
          example: 'Missing permission: canSendPackages'
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Validation problems keyed by field path. Present only on 422
            responses.
          example:
            recipients.0.email:
              - Invalid email
      required:
        - error
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: fsk_*

````