workspace

The caller's workspace

Plan, resolved entitlements (plan plus any one-off grant — what the scheduler applies), usage against the period allowance, and the brands the caller can reach with their role on each. Call this first: it says what the plan will let you do before you try. Usage is the whole workspace's, since the allowances are shared across its brands.

get/workspace

Request

  • Base URL: https://shruwd.io/api/v1
  • URL: https://shruwd.io/api/v1/workspace
  • Auth: HTTP bearer

Response

The workspace.

workspaceIdstring required
planCodestring required
status'active' | 'past_due' | 'canceled' required
role'owner' | 'member' required

owner: the workspace's owner, with every brand. member: a member of the brands listed, with the role on each in that brand's role.

Example response

{
  "entitlements": {
    "planCode": "starter_v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.