`workspaces`

Open an operation to see its authentication, its parameters and the fields of its request and response.

5 operations

GET`/v1/workspaces`

Workspaces the signed-in user can open, by name (team).

Authentication: Dashboard session

Parameters

Parameters, GET /v1/workspaces
Name	Type	Description
`cursor`query	`string`
`limit`query	`integer`
`include_archived`query	`boolean \| enum`	Values `0 \| 1 \| true \| false`

Response `200`

Response, GET /v1/workspaces
Name	Type	Description
`items`required	`array of object`
`items[].id`required	`string`
`items[].org_id`required	`string`
`items[].name`required	`string`
`items[].slug`required	`string`
`items[].client_name`required	`string`
`items[].brand_profile_id`required	`string`
`items[].resale_price`required	`number`
`items[].locale`required	`enum`	Values `en \| it`
`items[].execution_mode`required	`enum`	Values `managed \| runner \| mcp`
`items[].agent_id`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`items[].auth_method`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`items[].runner_transport`required	`enum`	Values `github_actions \| container`
`items[].agent_config`required	`object`
`items[].autonomy`required	`enum`	Values `copilot \| approve \| autopilot`
`items[].autopilot_categories`required	`array of enum`
`items[].confidence_threshold`required	`number`
`items[].share_policy`required	`enum`	Values `snippets \| references_only`
`items[].test_command`required	`string`
`items[].merge_method`required	`enum`	Values `squash \| merge \| rebase`
`items[].auto_merge`required	`boolean`
`items[].release_batching`required	`enum`	Values `per_ticket \| batched`
`items[].changelog_enabled`required	`boolean`
`items[].github_release_enabled`required	`boolean`
`items[].proactive_enabled`required	`boolean`
`items[].proactive_threshold_users`required	`integer`
`items[].proactive_monthly_fix_cap`required	`integer`
`items[].critical_paths`required	`array of string`
`items[].notify_affected_users`required	`boolean`
`items[].patterns_opt_in`required	`boolean`
`items[].sla_first_response_minutes`required	`integer`
`items[].sla_resolution_minutes`required	`integer`
`items[].report_recipients`required	`array of string (email)`
`items[].report_intro`required	`string`
`items[].report_auto_send`required	`boolean`
`items[].managed_addon`required	`boolean`
`items[].collect_via_connect`required	`boolean`
`items[].managed_fixes_with_credits`required	`boolean`
`items[].auto_close_days`required	`integer`
`items[].oss_auto_close_issues`required	`boolean`
`items[].oss_comments_per_hour`required	`integer`
`items[].archived_at`required	`string (date-time)`
`items[].created_at`required	`string (date-time)`
`items[].updated_at`required	`string (date-time)`
`next_cursor`required	`string`

POST`/v1/workspaces`

Creates a workspace with its mailbox and widget install (owner, admin).

Authentication: Dashboard session

Request body

Request body, POST /v1/workspaces
Name	Type	Description
`name`required	`string`
`slug`	`string`
`client_name`	`string`
`locale`	`enum`	Values `en \| it`
`execution_mode`	`enum`	Values `managed \| runner \| mcp`

Response `201`

Response, POST /v1/workspaces
Name	Type	Description
`id`required	`string`
`org_id`required	`string`
`name`required	`string`
`slug`required	`string`
`client_name`required	`string`
`brand_profile_id`required	`string`
`resale_price`required	`number`
`locale`required	`enum`	Values `en \| it`
`execution_mode`required	`enum`	Values `managed \| runner \| mcp`
`agent_id`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`auth_method`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`runner_transport`required	`enum`	Values `github_actions \| container`
`agent_config`required	`object`
`autonomy`required	`enum`	Values `copilot \| approve \| autopilot`
`autopilot_categories`required	`array of enum`
`confidence_threshold`required	`number`
`share_policy`required	`enum`	Values `snippets \| references_only`
`test_command`required	`string`
`merge_method`required	`enum`	Values `squash \| merge \| rebase`
`auto_merge`required	`boolean`
`release_batching`required	`enum`	Values `per_ticket \| batched`
`changelog_enabled`required	`boolean`
`github_release_enabled`required	`boolean`
`proactive_enabled`required	`boolean`
`proactive_threshold_users`required	`integer`
`proactive_monthly_fix_cap`required	`integer`
`critical_paths`required	`array of string`
`notify_affected_users`required	`boolean`
`patterns_opt_in`required	`boolean`
`sla_first_response_minutes`required	`integer`
`sla_resolution_minutes`required	`integer`
`report_recipients`required	`array of string (email)`
`report_intro`required	`string`
`report_auto_send`required	`boolean`
`managed_addon`required	`boolean`
`collect_via_connect`required	`boolean`
`managed_fixes_with_credits`required	`boolean`
`auto_close_days`required	`integer`
`oss_auto_close_issues`required	`boolean`
`oss_comments_per_hour`required	`integer`
`archived_at`required	`string (date-time)`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`inbound_address`required	`string`
`widget`required	`object`
`widget.public_key`required	`string`
`widget.allowed_origins`required	`array of string`
`release_strategy`required	`enum`	Values `semver \| calver \| manual`
`available_fix_credits`required	`integer`

GET`/v1/workspaces/{id}`

One workspace with its settings (team).

Authentication: Dashboard session

Parameters

Parameters, GET /v1/workspaces/{id}
Name	Type	Description
`id`pathrequired	`string`

Response `200`

The same fields as POST /v1/workspaces.

PATCH`/v1/workspaces/{id}`

Changes the settings of a workspace (owner, admin); every change is audited.

Authentication: Dashboard session

Parameters

Parameters, PATCH /v1/workspaces/{id}
Name	Type	Description
`id`pathrequired	`string`

Request body

Request body, PATCH /v1/workspaces/{id}
Name	Type	Description
`name`	`string`
`client_name`	`string`
`locale`	`enum`	Values `en \| it`
`brand_profile_id`	`string`
`execution_mode`	`enum`	Values `managed \| runner \| mcp`
`agent_id`	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`auth_method`	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`runner_transport`	`enum`	Values `github_actions \| container`
`agent_config`	`object`
`agent_config.model`	`string`
`agent_config.credential_id`	`string`
`agent_config.effort`	`string`
`agent_config.max_minutes`	`integer`
`agent_config.max_cost_usd`	`number`
`managed_fixes_with_credits`	`boolean`
`autonomy`	`enum`	Values `copilot \| approve \| autopilot`
`autopilot_categories`	`array of enum`
`confidence_threshold`	`number`
`share_policy`	`enum`	Values `snippets \| references_only`
`test_command`	`string`
`release_strategy`	`enum`	Values `semver \| calver \| manual`
`merge_method`	`enum`	Values `squash \| merge \| rebase`
`auto_merge`	`boolean`
`release_batching`	`enum`	Values `per_ticket \| batched`
`changelog_enabled`	`boolean`
`github_release_enabled`	`boolean`
`auto_close_days`	`integer`
`proactive_enabled`	`boolean`
`proactive_threshold_users`	`integer`
`proactive_monthly_fix_cap`	`integer`
`notify_affected_users`	`boolean`
`critical_paths`	`array of string`
`sla_first_response_minutes`	`integer`
`sla_resolution_minutes`	`integer`
`report_recipients`	`array of string`
`report_intro`	`string`
`report_auto_send`	`boolean`
`patterns_opt_in`	`boolean`
`oss_auto_close_issues`	`boolean`
`oss_comments_per_hour`	`integer`

Response `200`

The same fields as POST /v1/workspaces.

POST`/v1/workspaces/{id}/archive`

Archives a workspace: its mailbox stops receiving and its tokens are revoked.

Authentication: Dashboard session

Parameters

Parameters, POST /v1/workspaces/{id}/archive
Name	Type	Description
`id`pathrequired	`string`

Response `200`

The same fields as POST /v1/workspaces.

Name

Type

Description

cursorquery

string

limitquery

integer

include_archivedquery

boolean | enum

Values 0 | 1 | true | false

Name

Type

Description

itemsrequired

array of object

items[].idrequired

string

items[].org_idrequired

string

items[].namerequired

string

items[].slugrequired

string

items[].client_namerequired

string

items[].brand_profile_idrequired

string

items[].resale_pricerequired

number

items[].localerequired

enum

Values en | it

items[].execution_moderequired

enum

Values managed | runner | mcp

items[].agent_idrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

items[].auth_methodrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

items[].runner_transportrequired

enum

Values github_actions | container

items[].agent_configrequired

object

items[].autonomyrequired

enum

Values copilot | approve | autopilot

items[].autopilot_categoriesrequired

array of enum

items[].confidence_thresholdrequired

number

items[].share_policyrequired

enum

Values snippets | references_only

items[].test_commandrequired

string

items[].merge_methodrequired

enum

Values squash | merge | rebase

items[].auto_mergerequired

boolean

items[].release_batchingrequired

enum

Values per_ticket | batched

items[].changelog_enabledrequired

boolean

items[].github_release_enabledrequired

boolean

items[].proactive_enabledrequired

boolean

items[].proactive_threshold_usersrequired

integer

items[].proactive_monthly_fix_caprequired

integer

items[].critical_pathsrequired

array of string

items[].notify_affected_usersrequired

boolean

items[].patterns_opt_inrequired

boolean

items[].sla_first_response_minutesrequired

integer

items[].sla_resolution_minutesrequired

integer

items[].report_recipientsrequired

array of string (email)

items[].report_introrequired

string

items[].report_auto_sendrequired

boolean

items[].managed_addonrequired

boolean

items[].collect_via_connectrequired

boolean

items[].managed_fixes_with_creditsrequired

boolean

items[].auto_close_daysrequired

integer

items[].oss_auto_close_issuesrequired

boolean

items[].oss_comments_per_hourrequired

integer

items[].archived_atrequired

string (date-time)

items[].created_atrequired

string (date-time)

items[].updated_atrequired

string (date-time)

next_cursorrequired

string

Name

Type

Description

namerequired

string

slug

string

client_name

string

locale

enum

Values en | it

execution_mode

enum

Values managed | runner | mcp

Name

Type

Description

idrequired

string

org_idrequired

string

namerequired

string

slugrequired

string

client_namerequired

string

brand_profile_idrequired

string

resale_pricerequired

number

localerequired

enum

Values en | it

execution_moderequired

enum

Values managed | runner | mcp

agent_idrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

auth_methodrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

runner_transportrequired

enum

Values github_actions | container

agent_configrequired

object

autonomyrequired

enum

Values copilot | approve | autopilot

autopilot_categoriesrequired

array of enum

confidence_thresholdrequired

number

share_policyrequired

enum

Values snippets | references_only

test_commandrequired

string

merge_methodrequired

enum

Values squash | merge | rebase

auto_mergerequired

boolean

release_batchingrequired

enum

Values per_ticket | batched

changelog_enabledrequired

boolean

github_release_enabledrequired

boolean

proactive_enabledrequired

boolean

proactive_threshold_usersrequired

integer

proactive_monthly_fix_caprequired

integer

critical_pathsrequired

array of string

notify_affected_usersrequired

boolean

patterns_opt_inrequired

boolean

sla_first_response_minutesrequired

integer

sla_resolution_minutesrequired

integer

report_recipientsrequired

array of string (email)

report_introrequired

string

report_auto_sendrequired

boolean

managed_addonrequired

boolean

collect_via_connectrequired

boolean

managed_fixes_with_creditsrequired

boolean

auto_close_daysrequired

integer

oss_auto_close_issuesrequired

boolean

oss_comments_per_hourrequired

integer

archived_atrequired

string (date-time)

created_atrequired

string (date-time)

updated_atrequired

string (date-time)

inbound_addressrequired

string

widgetrequired

object

widget.public_keyrequired

string

widget.allowed_originsrequired

array of string

release_strategyrequired

enum

Values semver | calver | manual

available_fix_creditsrequired

integer

Name

Type

Description

idpathrequired

string

Name

Type

Description

idpathrequired

string

Name

Type

Description

name

string

client_name

string

locale

enum

Values en | it

brand_profile_id

string

execution_mode

enum

Values managed | runner | mcp

agent_id

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

auth_method

enum

Values api-key | chatgpt | bedrock | vertex | subscription

runner_transport

enum

Values github_actions | container

agent_config

object

agent_config.model

string

agent_config.credential_id

string

agent_config.effort

string

agent_config.max_minutes

integer

agent_config.max_cost_usd

number

managed_fixes_with_credits

boolean

autonomy

enum

Values copilot | approve | autopilot

autopilot_categories

array of enum

confidence_threshold

number

share_policy

enum

Values snippets | references_only

test_command

string

release_strategy

enum

Values semver | calver | manual

merge_method

enum

Values squash | merge | rebase

auto_merge

boolean

release_batching

enum

Values per_ticket | batched

changelog_enabled

boolean

github_release_enabled

boolean

auto_close_days

integer

proactive_enabled

boolean

proactive_threshold_users

integer

proactive_monthly_fix_cap

integer

notify_affected_users

boolean

critical_paths

array of string

sla_first_response_minutes

integer

sla_resolution_minutes

integer

report_recipients

array of string

report_intro

string

report_auto_send

boolean

patterns_opt_in

boolean

oss_auto_close_issues

boolean

oss_comments_per_hour

integer

Name

Type

Description

idpathrequired

string

GET/v1/workspaces

Parameters

Response 200

POST/v1/workspaces

Request body

Response 201

GET/v1/workspaces/{id}

Parameters

Response 200

PATCH/v1/workspaces/{id}

Parameters

Request body

Response 200

POST/v1/workspaces/{id}/archive

Parameters

Response 200

GET/v1/workspaces

Parameters

Response 200

POST/v1/workspaces

Request body

Response 201

GET/v1/workspaces/{id}

Parameters

Response 200

PATCH/v1/workspaces/{id}

Parameters

Request body

Response 200

POST/v1/workspaces/{id}/archive

Parameters

Response 200

GET`/v1/workspaces`

Response `200`

POST`/v1/workspaces`

Response `201`

GET`/v1/workspaces/{id}`

Response `200`

PATCH`/v1/workspaces/{id}`

Response `200`

POST`/v1/workspaces/{id}/archive`

Response `200`

GET`/v1/workspaces`

Response `200`

POST`/v1/workspaces`

Response `201`

GET`/v1/workspaces/{id}`

Response `200`

PATCH`/v1/workspaces/{id}`

Response `200`

POST`/v1/workspaces/{id}/archive`

Response `200`