Skip to content
noBSredir

Client workspaces

Client workspaces are sub-workspaces managed under a parent workspace. Agency plan only.

POST /workspaces/:wsId/clients

Create a client workspace under the current workspace. The client workspace starts on the free plan and is linked via parent_workspace_id.

Role: owner Plan: Agency required (returns 402 otherwise)

Terminal window
curl -X POST https://nobsredir.com/api/workspaces/ws_abc123/clients \
-H "X-API-Key: nobs_your_key" \
-H "Content-Type: application/json" \
-d '{"name": "Client Co", "slug": "client-co"}'

Body:

FieldTypeRequiredDescription
namestringyesClient workspace name
slugstringnoURL-safe identifier. Auto-generated from name if omitted.

Response 201:

{
"id": "ws_client456",
"name": "Client Co",
"slug": "client-co",
"plan": "free",
"parent_workspace_id": "ws_abc123"
}

Errors:

  • 400 - Name is required
  • 402 - Client workspaces require Agency plan
  • 409 - Slug already taken

GET /workspaces/:wsId/clients

List all client workspaces under the current workspace. Includes link and click counts.

Role: viewer+

Terminal window
curl https://nobsredir.com/api/workspaces/ws_abc123/clients \
-H "X-API-Key: nobs_your_key"

Response 200:

{
"clients": [
{
"id": "ws_client456",
"name": "Client Co",
"slug": "client-co",
"plan": "free",
"parent_workspace_id": "ws_abc123",
"link_count": 25,
"click_count": 1420,
"created_at": "2025-02-01T09:00:00.000Z"
}
]
}