Skip to main content
GET
Get workspace configuration

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST endpoints the Workspace write API scope.

Response

Success. Empty result sets are also 200.

Workspace settings, as the settings page shows them. Credential values never appear: toolCredentials reports only the type and which fields are set, and any other credential-shaped field is redacted.

id
string
required
name
string
required
toolCredentials
object[]
required
tags
string[]
featureFlags
object

Per-workspace feature toggles, keyed by flag name.

defaultDailyCreditLimitPerAgent
number

Applied to every agent that has no dailyCreditLimit of its own.

preferredLlmModel
string
llmDefaultMode
string
enabledLlmModels
string[]
disabledLlmModels
string[]
additionalLlmModelsForWorkspace
string[]
capabilityAdminSettings
object

Which capabilities agents may use, and the default for capabilities with no explicit entry.

accountRules
object
groupSettings
object

Teams. When enabled is false, /teams returns an empty list and the team write endpoints 400.

loginSettings
object
joinSettings
object
securityAlertSettings
object

Also served on its own at /security-settings.

notificationSettings
object
documentWriteAccess
object
agentValueCaptureSettings
object

The typeOfValue.categories[].id values here are the category ids /agents/value-entries accepts.

agentLifecycleSettings
object

Sandbox / production phases. Only active when the matching feature flag is also on.

dpa
object

Data processing agreement status and legal entity details.

subprocessorNoticePeriodDays
number
subprocessorAuthorizations
object

Keyed by subprocessor id: authorization status, who decided, and the notice audit trail. Redaction covers the whole block, so its string values read [redacted]; dates and booleans survive.

subscriptionLimits
object
seatsOverride
number
stripeSubscriptionStatus
string
stripeSubscriptionPlanName
string
stripeSubscriptionCreditsPerMonth
number
stripeTrialEnd
string

ISO 8601 timestamp.

creditRefillSchedule
object
suspendedAt
string

Set while the workspace is suspended.

{key}
any