Workspaces

Create and manage workspaces within your organization.

Workspaces

Workspaces provide logical grouping for connections, triggers, and other resources within an organization. Use workspaces to separate environments (staging, production) or teams.

List Workspaces

GET/api/v1/workspaces

List all workspaces in your organization.

Query Parameters

Field	Type	Required	Description
`limit`	integer	No	Number of workspaces to return, default `50`, max `100`
`offset`	integer	No	Number of workspaces to skip for pagination
`includeSuspended`	boolean	No	Include suspended workspaces. Defaults to `false`

Response

json

{
  "workspaces": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "orgId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Production",
      "slug": "production",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "total": 1
}

Example

bash

curl https://api.weavz.io/api/v1/workspaces \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

import { WeavzClient } from '@weavz/sdk'
 
const client = new WeavzClient({ apiKey: 'wvz_your_api_key' })
 
const { workspaces } = await client.workspaces.list()

python

from weavz_sdk import WeavzClient
 
client = WeavzClient(api_key="wvz_your_api_key")
 
result = client.workspaces.list()
workspaces = result["workspaces"]

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspaces', {
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

import httpx
 
res = httpx.get(
    "https://api.weavz.io/api/v1/workspaces",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Create Workspace

POST/api/v1/workspaces

Create a new workspace.

Request Body

Field	Type	Required	Description
`name`	string	Yes	Workspace name
`slug`	string	Yes	URL-friendly slug (unique within org)

Response (201)

json

{
  "workspace": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "orgId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Production",
    "slug": "production",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}

Example

bash

curl -X POST https://api.weavz.io/api/v1/workspaces \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production", "slug": "production"}'

typescript

const { workspace } = await client.workspaces.create({
  name: 'Production',
  slug: 'production',
})

python

result = client.workspaces.create(name="Production", slug="production")

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspaces', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer wvz_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Production', slug: 'production' }),
})
const data = await res.json()

python

res = httpx.post(
    "https://api.weavz.io/api/v1/workspaces",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={"name": "Production", "slug": "production"},
)
data = res.json()

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Invalid or missing name/slug
`403`	`QUOTA_EXCEEDED`	Workspace limit reached for your plan
`409`	`DUPLICATE`	Workspace slug already exists

Get Workspace

GET/api/v1/workspaces/:id

Retrieve a specific workspace.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Workspace ID

Response

json

{
  "workspace": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "orgId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Production",
    "slug": "production",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}

Example

bash

curl https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

const { workspace } = await client.workspaces.get('a1b2c3d4-e5f6-7890-abcd-ef1234567890')

python

result = client.workspaces.get("a1b2c3d4-e5f6-7890-abcd-ef1234567890")

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890', {
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.get(
    "https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Workspace not found

Update Workspace

PATCH/api/v1/workspaces/:id

Update a workspace name or slug.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Workspace ID

Request Body

Field	Type	Required	Description
`name`	string	No	New workspace name
`slug`	string	No	New workspace slug. Must be lowercase alphanumeric characters and hyphens, start with a letter or number, and be unique within the organization

Provide at least one field.

Response

json

{
  "workspace": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "orgId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Production EU",
    "slug": "production-eu",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T11:00:00.000Z"
  }
}

Example

bash

curl -X PATCH https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production EU", "slug": "production-eu"}'

typescript

const { workspace } = await client.workspaces.update(
  'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  { name: 'Production EU', slug: 'production-eu' },
)

python

result = client.workspaces.update(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    name="Production EU",
    slug="production-eu",
)

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer wvz_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Production EU', slug: 'production-eu' }),
})
const data = await res.json()

python

res = httpx.patch(
    "https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={"name": "Production EU", "slug": "production-eu"},
)
data = res.json()

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Invalid name or slug
`400`	`NO_UPDATES`	No fields provided
`403`	`SCOPE_DENIED`	API key does not have access to this workspace
`404`	`NOT_FOUND`	Workspace not found
`409`	`DUPLICATE`	Workspace slug already exists

Delete Workspace

DELETE/api/v1/workspaces/:id

Delete a workspace and all associated resources.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Workspace ID

Response

json

{
  "deleted": true,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Example

bash

curl -X DELETE https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

await client.workspaces.delete('a1b2c3d4-e5f6-7890-abcd-ef1234567890')

python

client.workspaces.delete("a1b2c3d4-e5f6-7890-abcd-ef1234567890")

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.delete(
    "https://api.weavz.io/api/v1/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Workspace not found