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

# Workspace

## 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

<ResponseField name="id" type="string" required>
  Unique identifier for the workspace

  **Example:** `ws_123`
</ResponseField>

<ResponseField name="name" type="string" required>
  Workspace name

  **Example:** `Acme Corp`
</ResponseField>

<ResponseField name="slug" type="string">
  URL-friendly workspace identifier

  **Example:** `acme-corp`
</ResponseField>

<ResponseField name="personal" type="boolean" required>
  Whether this is a personal workspace (automatically created for each user)

  **Example:** `false`
</ResponseField>

<ResponseField name="membership" type="object">
  Current user's membership information in this workspace

  <Expandable title="membership properties">
    <ResponseField name="role" type="string" required>
      User's role in the workspace. Can be `owner`, `admin`, or `member`
    </ResponseField>

    <ResponseField name="created_at" type="string" required>
      ISO 8601 timestamp when the membership was created
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="settings" type="object" required>
  Workspace configuration settings

  **Example:** `{ "onboarding": { "fullName": true, "companyName": false } }`
</ResponseField>

<ResponseField name="is_pro" type="boolean" required>
  Whether the workspace has a pro subscription

  **Example:** `false`
</ResponseField>

<ResponseField name="public_signup" type="boolean" required>
  Whether public signup is enabled for this workspace's apps

  **Example:** `false`
</ResponseField>

<ResponseField name="user_info_requirement" type="string" required>
  Level of user information required during signup. Can be `none`, `email`, or `full`

  **Example:** `email`
</ResponseField>

<ResponseField name="logo_url" type="string">
  URL to the workspace logo image

  **Example:** `https://example.com/logo.png`
</ResponseField>

<ResponseField name="created_at" type="string" required>
  ISO 8601 timestamp when the workspace was created
</ResponseField>

<ResponseField name="updated_at" type="string" required>
  ISO 8601 timestamp when the workspace was last updated
</ResponseField>

## Example Workspace Object

```json theme={null}
{
  "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"
}
```
