SnozeDevelopers
API referenceAdmin workspaces

Read one workspace's operational state

Returns a single workspace's plan, limit overrides, and AI usage. Platform admins only; an unknown `workspaceId` is reported as not found.

GET
/v1/admin/workspaces/{workspaceId}
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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/admin/workspaces/string"
{  "data": {    "workspaceId": "string",    "name": "string",    "slug": "string",    "lifecycleStatus": "active",    "memberCount": 0,    "billedPlan": "free",    "subscriptionStatus": "none",    "effectivePlan": "free",    "currentPeriodEnd": "string",    "override": {      "planOverride": "free",      "aiMonthlyBonusMicrousd": 0,      "aiBurstBonusMicrousd": 0,      "featureGrants": [        "integrations"      ],      "reason": "string",      "expiresAt": "string",      "updatedAt": "string"    },    "lastResetAt": "string",    "aiUsage": {      "plan": "free",      "unlimited": true,      "monthly": {        "capMicrousd": 0,        "usedMicrousd": 0,        "remaining": 0,        "refillsAt": "string"      },      "burst": {        "capMicrousd": 0,        "usedMicrousd": 0,        "remaining": 0,        "refillsAt": "string"      },      "onboardingGrantActive": true,      "topupBalanceMicrousd": 0,      "topupsAvailable": true    }  }}