Skip to main content

​
The Workspace Object

Workspaces are the top-level organizational unit in Scute. Each workspace can contain multiple apps and has its own members with different roles.

​
Attributes

​
id
string
required
Unique identifier for the workspaceExample: ws_123
​
name
string
required
Workspace nameExample: Acme Corp
​
slug
string
URL-friendly workspace identifierExample: acme-corp
​
personal
boolean
required
Whether this is a personal workspace (automatically created for each user)Example: false
​
membership
object
Current user’s membership information in this workspace
​
settings
object
required
Workspace configuration settingsExample: { "onboarding": { "fullName": true, "companyName": false } }
​
is_pro
boolean
required
Whether the workspace has a pro subscriptionExample: false
​
public_signup
boolean
required
Whether public signup is enabled for this workspace’s appsExample: false
​
user_info_requirement
string
required
Level of user information required during signup. Can be none, email, or fullExample: email
​
logo_url
string
URL to the workspace logo imageExample: https://example.com/logo.png
​
created_at
string
required
ISO 8601 timestamp when the workspace was created
​
updated_at
string
required
ISO 8601 timestamp when the workspace was last updated

​
Example Workspace Object

{
  "id": "ws_123",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "personal": false,
  "membership": {
    "role": "owner",
    "created_at": "2024-01-15T10:30:00Z"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "settings": {
    "onboarding": {
      "fullName": true,
      "companyName": false
    }
  },
  "is_pro": false,
  "public_signup": false,
  "user_info_requirement": "email",
  "logo_url": "https://example.com/logo.png"
}