The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Workspaces
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces
4---
5
16# Workspaces
27
38## List Workspaces
from line 39
3439
3540- `data: array of BetaWorkspace`
3641
42 - `type: "workspace"`
43
44 Object type.
45
46 For Workspaces, this is always `"workspace"`.
47
48 default: workspace
49
3750 - `id: string`
3851
3952 ID of the Workspace.
from line 123
110123
111124 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
112125
113 - `type: "workspace"`
114
115 Object type.
116
117 For Workspaces, this is always `"workspace"`.
118
119 default: workspace
120
121126- `first_id: string or null`
122127
123128 First ID in the `data` list. Can be used as the `before_id` for the previous page.
from line 188
183188
184189 - `string`
185190
186 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
191 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
187192
188193 - `"message-batches-2024-09-24"`
189194
from line 236
231236
232237 - `"user-profiles-2026-08-18"`
233238
239 - `"user-profiles-2026-09-04"`
240
234241 - `"advisor-tool-2026-03-01"`
235242
236243 - `"managed-agents-2026-04-01"`
from line 344
337344
338345- `BetaWorkspace object`
339346
347 - `type: "workspace"`
348
349 Object type.
350
351 For Workspaces, this is always `"workspace"`.
352
353 default: workspace
354
340355 - `id: string`
341356
342357 ID of the Workspace.
from line 428
413428
414429 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
415430
416 - `type: "workspace"`
417
418 Object type.
419
420 For Workspaces, this is always `"workspace"`.
421
422 default: workspace
423
424431### Example
425432
426433```bash
from line 486
479486
480487- `BetaWorkspace object`
481488
489 - `type: "workspace"`
490
491 Object type.
492
493 For Workspaces, this is always `"workspace"`.
494
495 default: workspace
496
482497 - `id: string`
483498
484499 ID of the Workspace.
from line 570
555570
556571 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
557572
558 - `type: "workspace"`
559
560 Object type.
561
562 For Workspaces, this is always `"workspace"`.
563
564 default: workspace
565
566573### Example
567574
568575```bash
from line 672
665672
666673- `BetaWorkspace object`
667674
675 - `type: "workspace"`
676
677 Object type.
678
679 For Workspaces, this is always `"workspace"`.
680
681 default: workspace
682
668683 - `id: string`
669684
670685 ID of the Workspace.
from line 756
741756
742757 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
743758
744 - `type: "workspace"`
745
746 Object type.
747
748 For Workspaces, this is always `"workspace"`.
749
750 default: workspace
751
752759### Example
753760
754761```bash
from line 811
804811
805812- `BetaWorkspace object`
806813
814 - `type: "workspace"`
815
816 Object type.
817
818 For Workspaces, this is always `"workspace"`.
819
820 default: workspace
821
807822 - `id: string`
808823
809824 ID of the Workspace.
from line 895
880895
881896 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
882897
883 - `type: "workspace"`
884
885 Object type.
886
887 For Workspaces, this is always `"workspace"`.
888
889 default: workspace
890
891898### Example
892899
893900```bash
from line 1026
10191026
10201027- `BetaWorkspace object`
10211028
1029 - `type: "workspace"`
1030
1031 Object type.
1032
1033 For Workspaces, this is always `"workspace"`.
1034
1035 default: workspace
1036
10221037 - `id: string`
10231038
10241039 ID of the Workspace.
from line 1110
10951110
10961111 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
10971112
1098 - `type: "workspace"`
1099
1100 Object type.
1101
1102 For Workspaces, this is always `"workspace"`.
1103
1104 default: workspace
1105
11061113### Beta Workspace Member
11071114
11081115- `BetaWorkspaceMember object`
from line 1216
12091216
12101217 Rate-limit entries for the workspace, one per group that has at least one override.
12111218
1219 - `type: "workspace_rate_limit"`
1220
1221 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
1222
1223 default: workspace_rate_limit
1224
12121225 - `group_type: "batch" or "files" or "model_group" or 3 more`
12131226
12141227 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
from line 1242
12291242
12301243 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
12311244
1232 - `org_limit: number or null`
1233
1234 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
1235
12361245 - `type: string`
12371246
12381247 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
12391248
1249 - `org_limit: number or null`
1250
1251 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
1252
12401253 - `value: number`
12411254
12421255 The workspace-level override value for this limiter type.
from line 1262
12491262
12501263 The `id` of the RateLimit group this override applies to.
12511264
1252 - `type: "workspace_rate_limit"`
1253
1254 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
1255
1256 default: workspace_rate_limit
1257
12581265 - `workspace_id: string`
12591266
12601267 ID of the Workspace this override applies to.
from line 1750
17431750
17441751 - `string`
17451752
1746 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1753 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
17471754
17481755 - `"message-batches-2024-09-24"`
17491756
from line 1798
17911798
17921799 - `"user-profiles-2026-08-18"`
17931800
1801 - `"user-profiles-2026-09-04"`
1802
17941803 - `"advisor-tool-2026-03-01"`
17951804
17961805 - `"managed-agents-2026-04-01"`
from line 1846
18371846
18381847- `data: array of BetaServiceAccountWorkspaceMember`
18391848
1849 - `type: "service_account_workspace_member"`
1850
1851 default: service_account_workspace_member
1852
18401853 - `created_by_actor_id: string or null`
18411854
18421855 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 1862
18491862
18501863 Tagged service account ID (`svac_...`).
18511864
1852 - `type: "service_account_workspace_member"`
1853
1854 default: service_account_workspace_member
1855
18561865 - `workspace_id: string`
18571866
18581867 Tagged workspace ID (`wrkspc_...`).
from line 1941
19321941
19331942 - `string`
19341943
1935 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1944 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
19361945
19371946 - `"message-batches-2024-09-24"`
19381947
from line 1989
19801989
19811990 - `"user-profiles-2026-08-18"`
19821991
1992 - `"user-profiles-2026-09-04"`
1993
19831994 - `"advisor-tool-2026-03-01"`
19841995
19851996 - `"managed-agents-2026-04-01"`
from line 2055
20442055
20452056- `BetaServiceAccountWorkspaceMember object`
20462057
2058 - `type: "service_account_workspace_member"`
2059
2060 default: service_account_workspace_member
2061
20472062 - `created_by_actor_id: string or null`
20482063
20492064 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 2071
20562071
20572072 Tagged service account ID (`svac_...`).
20582073
2059 - `type: "service_account_workspace_member"`
2060
2061 default: service_account_workspace_member
2062
20632074 - `workspace_id: string`
20642075
20652076 Tagged workspace ID (`wrkspc_...`).
from line 2148
21372148
21382149 - `string`
21392150
2140 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2151 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
21412152
21422153 - `"message-batches-2024-09-24"`
21432154
from line 2196
21852196
21862197 - `"user-profiles-2026-08-18"`
21872198
2199 - `"user-profiles-2026-09-04"`
2200
21882201 - `"advisor-tool-2026-03-01"`
21892202
21902203 - `"managed-agents-2026-04-01"`
from line 2244
22312244
22322245- `BetaServiceAccountWorkspaceMember object`
22332246
2247 - `type: "service_account_workspace_member"`
2248
2249 default: service_account_workspace_member
2250
22342251 - `created_by_actor_id: string or null`
22352252
22362253 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 2260
22432260
22442261 Tagged service account ID (`svac_...`).
22452262
2246 - `type: "service_account_workspace_member"`
2247
2248 default: service_account_workspace_member
2249
22502263 - `workspace_id: string`
22512264
22522265 Tagged workspace ID (`wrkspc_...`).
from line 2332
23192332
23202333 - `string`
23212334
2322 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2335 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
23232336
23242337 - `"message-batches-2024-09-24"`
23252338
from line 2380
23672380
23682381 - `"user-profiles-2026-08-18"`
23692382
2383 - `"user-profiles-2026-09-04"`
2384
23702385 - `"advisor-tool-2026-03-01"`
23712386
23722387 - `"managed-agents-2026-04-01"`
from line 2442
24272442
24282443- `BetaServiceAccountWorkspaceMember object`
24292444
2445 - `type: "service_account_workspace_member"`
2446
2447 default: service_account_workspace_member
2448
24302449 - `created_by_actor_id: string or null`
24312450
24322451 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 2458
24392458
24402459 Tagged service account ID (`svac_...`).
24412460
2442 - `type: "service_account_workspace_member"`
2443
2444 default: service_account_workspace_member
2445
24462461 - `workspace_id: string`
24472462
24482463 Tagged workspace ID (`wrkspc_...`).
from line 2533
25182533
25192534 - `string`
25202535
2521 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2536 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
25222537
25232538 - `"message-batches-2024-09-24"`
25242539
from line 2581
25662581
25672582 - `"user-profiles-2026-08-18"`
25682583
2584 - `"user-profiles-2026-09-04"`
2585
25692586 - `"advisor-tool-2026-03-01"`
25702587
25712588 - `"managed-agents-2026-04-01"`
from line 2627
26102627
26112628#### Returns
26122629
2613- `service_account_id: string`
2614
2615 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
2616
26172630- `type: "service_account_workspace_member_deleted"`
26182631
26192632 default: service_account_workspace_member_deleted
2633
2634- `service_account_id: string`
2635
2636 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
26202637
26212638- `workspace_id: string`
26222639