Sign in
workspaces

Get workspace settings

Plan: Enterprise

Returns a curated subset of the workspace's settings.

get/v1/workspaces/{workspace_id}/settings

Path parameters

workspace_idstring required

Workspace ID

Workspace ID

Response

OK

billing_period_end_datestring date-time

End of the current billing period.

billing_period_start_datestring date-time

Start of the current billing period.

default_monthly_member_credit_limitnumber double

Default monthly credit cap applied to each member who has no explicit per-member limit. Absent when unset (members are bounded only by the workspace balance) or when the caller lacks permission to view workspace usage.

default_project_visibilitystring

Default visibility applied to new projects. One of: public, private, draft. Absent means the workspace effective default of private.

enable_piiboolean required

Whether PII scanning is enabled across project resources.

enforce_ssoboolean required

Whether SSO is enforced for all members.

idstring required

Workspace ID.

namestring required

Workspace display name.

num_seatsinteger

Workspace-specific seat limit when one has been explicitly configured. Absent when the workspace runs on its plan's default (Enterprise workspaces are typically unlimited unless a per-tenant cap is set).

planstring required

Plan tier. One of: free, pro, business, enterprise. More values may be added; clients must tolerate unknown values.

publishing_policystring

Restriction on what publish visibilities are allowed: workspace_only or disabled. Absent means no restriction.

Example response

{
  "billing_period_end_date": "2026-02-01T00:00:00Z",
  "billing_period_start_date": "2026-01-01T00:00:00Z",
  "default_monthly_member_credit_limit": 500,
  "default_project_visibility": "private",
  "enable_pii": true,
  "enforce_sso": true,
  "id": "workspace_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "name": "Acme Inc",
  "num_seats": 25,
  "plan": "enterprise",
  "publishing_policy": "workspace_only"
}

Changes