SnozeDevelopers
API referenceWorkspaces

Seed a workspace from a starter template

Seeds the workspace with the databases, records, views, and pages of the named onboarding starter template, and records the onboarding analytics events around it. The seeding runs as the caller, so it requires `databases:write` and `surfaces:write` in the workspace. It is not idempotent: applying a starter twice creates the content twice.

POST
/v1/workspaces/{workspaceId}/starter
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/starter" \  -H "Content-Type: application/json" \  -d '{    "template": "team"  }'
{  "data": {    "template": "team"  }}