Skip to main content

​
Workspaces

Workspaces are the top-level organizational unit in Tokencraft. Each workspace can contain multiple tokensets and serves as a container for related design tokens.

​
What is a Workspace?

A workspace is a collection of tokensets that typically represent a single project, product, or design system. Think of it as a folder that groups all your design tokens together.

​
Example Structure

Workspace: "Mobile App"
├── Tokenset: "Colors"
├── Tokenset: "Typography"
└── Tokenset: "Spacing"

Workspace: "Marketing Website"
├── Tokenset: "Brand Colors"
└── Tokenset: "Components"

​
Creating a Workspace

You can create workspaces via the UI or API: 
curl -X POST https://app.tokencraft.dev/api/v1/workspaces \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Design System",
    "description": "Main product design system"
  }'

​
Workspace Properties

PropertyTypeDescription
idstringUnique identifier
namestringWorkspace name
descriptionstringOptional description
user_idstringOwner’s user ID
created_attimestampCreation date
updated_attimestampLast update date

​
Best Practices

​
1. Organize by Project

Create separate workspaces for different projects or products:
  • ✅ “Mobile App” workspace
  • ✅ “Web Dashboard” workspace
  • ✅ “Marketing Site” workspace

​
2. Use Descriptive Names

Make workspace names clear and descriptive:
  • ✅ “E-commerce Platform - Design System”
  • ❌ “DS1”

​
3. Add Descriptions

Include helpful descriptions: 
{
  "name": "Mobile App",
  "description": "Design tokens for iOS and Android apps. Includes light and dark modes."
}

​
4. One System Per Workspace

Keep related tokens together:
  • ✅ All mobile app tokens in one workspace
  • ❌ Mixing unrelated projects

​
Managing Workspaces

​
Listing Workspaces

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://app.tokencraft.dev/api/v1/workspaces

​
Getting a Workspace

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://app.tokencraft.dev/api/v1/workspaces/{workspace_id}

​
Updating a Workspace

curl -X PATCH https://app.tokencraft.dev/api/v1/workspaces/{workspace_id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Name",
    "description": "Updated description"
  }'

​
Deleting a Workspace

curl -X DELETE https://app.tokencraft.dev/api/v1/workspaces/{workspace_id} \
  -H "Authorization: Bearer YOUR_TOKEN"
Deleting a workspace will also delete all its tokensets and tokens. This action cannot be undone.

​
Next Steps

Tokensets

Learn about tokensets within workspaces

API Reference

Explore workspace API endpoints