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

# List workspaces

> Lists the workspaces your token can reach, with the `id`, name, icon and plan of each. A workspace holds the flows of one customer, and its `id` is the `workspaceId` every other endpoint takes.

A token that reaches no workspace at all gets a `404` (`No workspaces found`), not an empty list.



## OpenAPI

````yaml /api-reference/specs/controlled-flows/v1.json get /v1/workspaces
openapi: 3.0.3
info:
  title: Controlled Flows API
  version: 1.0.0
  description: >-
    Read, build, validate and publish controlled flows and the tools agents
    call.
servers:
  - url: https://api.cloudhumans.com/typebot
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: The workspaces that hold your flows.
  - name: Flows
    description: >-
      Read, create, change, validate and publish flows. Writes land in the
      draft; only a publish makes them live.
  - name: Versions
    description: The saved versions of a flow, and restoring one.
  - name: Credentials
    description: >-
      REST API credentials that HTTP Request blocks send without exposing the
      secret in the flow.
paths:
  /v1/workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces
      description: >-
        Lists the workspaces your token can reach, with the `id`, name, icon and
        plan of each. A workspace holds the flows of one customer, and its `id`
        is the `workspaceId` every other endpoint takes.


        A token that reaches no workspace at all gets a `404` (`No workspaces
        found`), not an empty list.
      operationId: listWorkspaces
      responses:
        '200':
          description: The workspaces your token reaches.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceList'
        '400':
          description: >-
            The request could not be answered as written. `message` says which
            input was rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, expired or invalid credentials.
        '404':
          description: The credentials reach no workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit applied by the API gateway. Back off and retry.
components:
  schemas:
    WorkspaceList:
      type: object
      required:
        - workspaces
      properties:
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/Workspace'
          description: The workspaces your token reaches.
      description: The workspaces your token can reach.
    Error:
      type: object
      properties:
        message:
          type: string
          description: What went wrong.
        code:
          type: string
          description: Error code, e.g. `NOT_FOUND` or `BAD_REQUEST`.
        issues:
          type: array
          description: Per-field validation problems, present on a 400 for invalid input.
          items:
            type: object
            additionalProperties: true
      required:
        - message
        - code
      description: Something the caller needs to fix.
    Workspace:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          description: The workspace id — the `workspaceId` other endpoints take.
        name:
          type: string
          description: The workspace's name.
        icon:
          nullable: true
          type: string
          description: An emoji or image URL shown next to the workspace name.
        plan:
          type: string
          description: >-
            The workspace's plan, e.g. `FREE`, `STARTER`, `PRO`, `LIFETIME`,
            `OFFERED`, `CUSTOM` or `UNLIMITED`.
      description: 'A workspace: the container of one customer''s flows.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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