> ## 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 workspaces

> Returns the workspace the API key was issued for. `active` confirms which workspace this call acted in.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/workspaces
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/workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces
      description: >-
        Returns the workspace the API key was issued for. `active` confirms
        which workspace this call acted in.
      operationId: getWorkspaces
      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: object
                    properties:
                      active:
                        type: string
                        description: Id of the workspace this call acted in.
                        example: cmg1gz5qk0001v8p9a3m2ud7h
                      workspaces:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                Workspace id. The value to send as
                                `X-Workspace-Id`.
                              example: cmg1gz5qk0001v8p9a3m2ud7h
                            name:
                              type: string
                              description: Workspace name.
                              example: Sales
                            slug:
                              type: string
                              description: >-
                                URL-safe identifier used in the app's workspace
                                URLs.
                              example: sales
                            isDefault:
                              type: boolean
                              description: >-
                                True for the organisation's default workspace,
                                the one members land in when none is chosen.
                                Exactly one workspace per organisation is the
                                default.
                              example: false
                          required:
                            - id
                            - name
                            - slug
                            - isDefault
                        description: >-
                          The workspaces the key can act in. For an API key this
                          is exactly one: the workspace it was issued for. To
                          act in another workspace, issue another key.
                    required:
                      - active
                      - workspaces
                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_*

````