Skip to main content
GET
/
v1
/
workspaces
List workspaces
curl --request GET \
  --url https://{defaultHost}/v1/workspaces \
  --header 'X-Authorization: <api-key>'
{
  "workspaces": [
    {
      "id": "ws_123",
      "name": "Acme Corp",
      "personal": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "is_pro": false,
      "public_signup": false,
      "user_info_requirement": "email",
      "slug": "acme-corp",
      "membership": {
        "role": "owner",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "settings": {
        "onboarding": {
          "fullName": true,
          "companyName": false
        }
      },
      "logo_url": "https://example.com/logo.png"
    }
  ]
}

Authorizations

X-Authorization
string
header
required

User Access token

Response

successful

workspaces
object[]