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

# List Workspaces

> Requires `workspaces-read`.

# List Workspaces

Return the workspaces the authenticated user belongs to.

## Authentication & Scope

Requires the `workspaces-read` ability.

## Request

```http theme={null}
GET /open/workspaces HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>
```

No query parameters are supported.

## Response

`200 OK` – An array of Workspace objects.

```json theme={null}
[
  {
    "id": 1,
    "name": "Marketing",
    "icon": "🚀",
    "settings": {
      "email_settings": {
        "from_name": "OpnForm"
      }
    },
    "max_file_size": 25,
    "is_readonly": false
  }
]
```

`403 Forbidden` – The token lacks `workspaces-read` or you do not have the necessary permissions.


## OpenAPI

````yaml get /open/workspaces
openapi: 3.0.1
info:
  title: OpnForm API
  description: API for interacting with OpnForm, primarily used for Zapier integration
  version: 1.0.0
servers:
  - url: https://api.opnform.com
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Create and manage workspaces.
  - name: Workspace Users
    description: Manage users within a workspace.
  - name: Forms
    description: Manage and retrieve forms.
  - name: Submissions
    description: Access and manage form submissions.
  - name: Integrations
    description: Manage form integrations (webhooks) via API.
  - name: Zapier
    description: Legacy endpoints for the Zapier integration.
paths:
  /open/workspaces:
    get:
      tags:
        - Workspaces
      summary: List Workspaces
      description: Requires `workspaces-read`.
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Workspace'
        '403':
          description: Forbidden
      security:
        - bearerAuth: []
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: number
          description: The unique identifier for the workspace.
          example: 1
          readOnly: true
        name:
          type: string
          description: The name of the workspace.
          example: My Marketing Team
        icon:
          type: string
          description: The emoji or icon representing the workspace.
          example: 🚀
        settings:
          type: object
          description: General settings for the workspace.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Personal Access Token
      x-bearer-scopemap:
        workspaces-read: Read access to workspaces
        workspaces-write: Write access to workspaces
        workspace-users-read: Read access to workspace users
        workspace-users-write: Write access to workspace users
        forms-read: Read access to forms
        forms-write: Write access to forms
        manage-integrations: Manage form integrations (webhooks)

````