Skip to main content
GET
/
open
/
workspaces
List Workspaces
curl --request GET \
  --url https://api.opnform.com/open/workspaces \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "name": "My Marketing Team",
    "icon": "🚀",
    "settings": {}
  }
]

​
List Workspaces

Return the workspaces the authenticated user belongs to.

​
Authentication & Scope

Requires the workspaces-read ability.

​
Request

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. 
[
  {
    "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.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Response

Successful

​
id
number

The unique identifier for the workspace.

Example:

1

​
name
string

The name of the workspace.

Example:

"My Marketing Team"

​
icon
string

The emoji or icon representing the workspace.

Example:

"🚀"

​
settings
object

General settings for the workspace.