Workspaces

Workspaces are the top-level containers for teams in Moonshadow. Every workspace holds its own members, integrations, and event history. Use these endpoints to create new workspaces, list your existing ones, and update workspace settings.

---

List Workspaces

Returns a paginated list of workspaces you have access to.

curl -G https://api.moonshadow.dev/v1/workspaces \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "limit=20"

Query Parameters

limit · integer · default: "20"

Number of workspaces to return. Maximum is 100.

cursor · string

Cursor from a previous response to fetch the next page.

Response

data · array

Array of workspace objects.

data[].id · string

Unique workspace identifier, e.g. ws_abc123.

data[].name · string

Human-readable workspace name.

data[].slug · string

URL-friendly unique identifier for the workspace.

data[].plan · string

Billing plan: free, team, or enterprise.

pagination · object

Cursor pagination metadata.

{
  "data": [
    {
      "id": "ws_abc123",
      "name": "Engineering",
      "slug": "engineering",
      "plan": "team",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-03-01T14:22:00Z"
    },
    {
      "id": "ws_def456",
      "name": "Design",
      "slug": "design",
      "plan": "free",
      "created_at": "2024-02-10T09:00:00Z",
      "updated_at": "2024-02-10T09:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6IndzX2RlZjQ1NiJ9",
    "has_more": true
  }
}

---

Create a Workspace

Creates a new workspace for your team.

curl -X POST https://api.moonshadow.dev/v1/workspaces \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing",
    "slug": "marketing",
    "plan": "team"
  }'

Request Body

name · string · required

Display name for the workspace. Must be between 1 and 100 characters.

slug · string · required

URL-friendly unique identifier. Must match ^[a-z0-9-]+$ and be 2 to 50 characters.

plan · string · default: "free"

Billing plan for the workspace. Options: free, team, enterprise.

Response

Returns the newly created workspace object with a generated id.

{
  "id": "ws_ghi789",
  "name": "Marketing",
  "slug": "marketing",
  "plan": "team",
  "created_at": "2024-06-10T16:45:00Z",
  "updated_at": "2024-06-10T16:45:00Z"
}

---

Get a Workspace

Retrieves a single workspace by its ID.

curl https://api.moonshadow.dev/v1/workspaces/ws_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id · string · required

The workspace ID, e.g. ws_abc123.

Response

{
  "id": "ws_abc123",
  "name": "Engineering",
  "slug": "engineering",
  "plan": "team",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-03-01T14:22:00Z"
}

---

Update a Workspace

Updates fields on an existing workspace.

curl -X PATCH https://api.moonshadow.dev/v1/workspaces/ws_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Engineering Team",
    "plan": "enterprise"
  }'

Path Parameters

id · string · required

The workspace ID to update.

Request Body

name · string

New display name for the workspace.

slug · string

New slug. Must still be globally unique.

plan · string

New billing plan: free, team, or enterprise.

Response

Returns the updated workspace object.

{
  "id": "ws_abc123",
  "name": "Engineering Team",
  "slug": "engineering",
  "plan": "enterprise",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-10T17:00:00Z"
}

Changing a workspace’s plan may trigger billing changes. Use with care in production.