api-20260825T033708Z / page 5 of 16 / documentation capture

api/admin/spend_limits/increase_requests/deny Changed · +50 / -45 lines

# Deny Spend Limit Increase Request ## Path parameters ## Body parameters ## Returns ## Example ### Response (200) ## Deny Spend Limit Increase Request ### Path Parameters ### Body Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Deny Spend Limit Increase Request

3url: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/deny

4---

1# Deny Spend Limit Increase Request

52

6## Deny Spend Limit Increase Request

3**POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny`

74

8**post** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny`

9

105Deny a pending spend limit increase request.

116

127Idempotent on `denied`; denying an already-`approved` request returns

138400. Anthropic emails the requester unless `suppress_notification` is set.

149

15### Path Parameters

10## Path parameters

1611

1712- `spend_limit_increase_request_id: string`

1813

1914 ID of the spend limit increase request.

2015

21### Body Parameters

16## Body parameters

2217

2318- `suppress_notification: optional boolean`

2419

25### Returns

20## Returns

2621

27- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`

22- `SpendLimitIncreaseRequest object`

2823

2924 - `id: string`

3025

31 - `actor: object { deleted, email_address, name, 2 more }`

26 - `actor: object`

3227

3328 A user within the organization. `name` and `email_address` are

3429 null when the underlying account is unavailable or has been deleted;

from line 31

3631

3732 - `deleted: boolean`

3833

34 default: false

35

3936 - `email_address: string or null`

4037

4138 - `name: string or null`

from line 39

4239

4340 - `type: "user_actor"`

4441

45 - `"user_actor"`

42 default: user_actor

4643

4744 - `user_id: string`

4845

4946 - `created_at: string`

5047

48 format: date-time

49

5150 - `period: "daily" or "monthly" or "weekly"`

5251

5352 - `"daily"`

from line 57

5857

5958 - `resolved_at: string or null`

6059

61 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`

60 format: date-time

6261

62 - `resolved_by: object or object or null`

63

6364 A user within the organization. `name` and `email_address` are

6465 null when the underlying account is unavailable or has been deleted;

6566 `deleted` is true only for deleted accounts.

6667

67 - `UserActor object { deleted, email_address, name, 2 more }`

68 - `UserActor object`

6869

6970 A user within the organization. `name` and `email_address` are

7071 null when the underlying account is unavailable or has been deleted;

from line 73

7273

7374 - `deleted: boolean`

7475

76 default: false

77

7578 - `email_address: string or null`

7679

7780 - `name: string or null`

from line 81

7881

7982 - `type: "user_actor"`

8083

81 - `"user_actor"`

84 default: user_actor

8285

8386 - `user_id: string`

8487

85 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`

88 - `ScopedAPIKeyActor object`

8689

8790 A scoped Admin API key acting on behalf of the organization.

8891

from line 93

9093

9194 - `type: "scoped_api_key_actor"`

9295

93 - `"scoped_api_key_actor"`

96 default: scoped_api_key_actor

9497

9598 - `spend_summary: SpendSummary or null`

9699

97100 Per-member effective-limit report row (GET /spend_limits/effective).

98101

99 - `actor: object { deleted, email_address, name, 2 more }`

102 - `actor: object`

100103

101104 A user within the organization. `name` and `email_address` are

102105 null when the underlying account is unavailable or has been deleted;

from line 107

104107

105108 - `deleted: boolean`

106109

110 default: false

111

107112 - `email_address: string or null`

108113

109114 - `name: string or null`

from line 115

110115

111116 - `type: "user_actor"`

112117

113 - `"user_actor"`

118 default: user_actor

114119

115120 - `user_id: string`

116121

from line 139

134139

135140 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.

136141

137 - `scope: object { type, user_id }`

142 - `scope: object`

138143

139144 - `type: "user"`

140145

141 - `"user"`

146 default: user

142147

143148 - `user_id: string`

144149

145 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`

150 - `source: object or object or object or 2 more`

146151

147 - `User object { type, user_id }`

152 - `User object`

148153

149154 - `type: "user"`

150155

151 - `"user"`

156 default: user

152157

153158 - `user_id: string`

154159

155 - `SeatTier object { seat_tier, type }`

160 - `SeatTier object`

156161

157162 - `seat_tier: string`

158163

159164 - `type: "seat_tier"`

160165

161 - `"seat_tier"`

166 default: seat_tier

162167

163 - `RbacGroup object { rbac_group_id, type }`

168 - `RbacGroup object`

164169

165170 - `rbac_group_id: string`

166171

167172 - `type: "rbac_group"`

168173

169 - `"rbac_group"`

174 default: rbac_group

170175

171 - `OrganizationService object { service, type }`

176 - `OrganizationService object`

172177

173178 - `service: string`

174179

175180 - `type: "organization_service"`

176181

177 - `"organization_service"`

182 default: organization_service

178183

179 - `Organization object { type }`

184 - `Organization object`

180185

181186 - `type: "organization"`

182187

183 - `"organization"`

188 default: organization

184189

185190 - `spend_limit_id: string`

186191

from line 199

194199

195200 - `type: "spend_limit_increase_request"`

196201

197 - `"spend_limit_increase_request"`

202 default: spend_limit_increase_request

198203

199### Example

204## Example

200205

201```http

206```bash

202207curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \

203208 -H 'Content-Type: application/json' \

204209 -H 'anthropic-version: 2023-06-01' \

from line 211

206211 -d '{}'

207212```

208213

209#### Response

214### Response (200)

210215

211216```json

212217{

api/admin/spend_limits/increase_requests/list Changed · +48 / -41 lines

# List Spend Limit Increase Requests ## Query parameters ## Returns ## Example ### Response (200) ## List Spend Limit Increase Requests ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: List Spend Limit Increase Requests

3url: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/list

4---

1# List Spend Limit Increase Requests

52

6## List Spend Limit Increase Requests

3**GET** `/v1/organizations/spend_limit_increase_requests`

74

8**get** `/v1/organizations/spend_limit_increase_requests`

9

105List spend limit increase requests, most recent first.

116

127Pending requests include a live `spend_summary` for the requester.

138Requests whose requester is no longer a member are excluded.

149

15### Query Parameters

10## Query parameters

1611

1712- `actor_ids: optional array of string`

1813

from line 15

2015

2116- `limit: optional number`

2217

18 default: 20, maximum: 1000, minimum: 1

19

2320- `page: optional string`

2421

2522 Opaque cursor from a previous response's `next_page`.

from line 31

3431

3532 - `"pending"`

3633

37### Returns

34## Returns

3835

3936- `data: array of SpendLimitIncreaseRequest`

4037

4138 - `id: string`

4239

43 - `actor: object { deleted, email_address, name, 2 more }`

40 - `actor: object`

4441

4542 A user within the organization. `name` and `email_address` are

4643 null when the underlying account is unavailable or has been deleted;

from line 45

4845

4946 - `deleted: boolean`

5047

48 default: false

49

5150 - `email_address: string or null`

5251

5352 - `name: string or null`

from line 53

5453

5554 - `type: "user_actor"`

5655

57 - `"user_actor"`

56 default: user_actor

5857

5958 - `user_id: string`

6059

6160 - `created_at: string`

6261

62 format: date-time

63

6364 - `period: "daily" or "monthly" or "weekly"`

6465

6566 - `"daily"`

from line 71

7071

7172 - `resolved_at: string or null`

7273

73 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`

74 format: date-time

7475

76 - `resolved_by: object or object or null`

77

7578 A user within the organization. `name` and `email_address` are

7679 null when the underlying account is unavailable or has been deleted;

7780 `deleted` is true only for deleted accounts.

7881

79 - `UserActor object { deleted, email_address, name, 2 more }`

82 - `UserActor object`

8083

8184 A user within the organization. `name` and `email_address` are

8285 null when the underlying account is unavailable or has been deleted;

from line 87

8487

8588 - `deleted: boolean`

8689

90 default: false

91

8792 - `email_address: string or null`

8893

8994 - `name: string or null`

from line 95

9095

9196 - `type: "user_actor"`

9297

93 - `"user_actor"`

98 default: user_actor

9499

95100 - `user_id: string`

96101

97 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`

102 - `ScopedAPIKeyActor object`

98103

99104 A scoped Admin API key acting on behalf of the organization.

100105

from line 107

102107

103108 - `type: "scoped_api_key_actor"`

104109

105 - `"scoped_api_key_actor"`

110 default: scoped_api_key_actor

106111

107112 - `spend_summary: SpendSummary or null`

108113

109114 Per-member effective-limit report row (GET /spend_limits/effective).

110115

111 - `actor: object { deleted, email_address, name, 2 more }`

116 - `actor: object`

112117

113118 A user within the organization. `name` and `email_address` are

114119 null when the underlying account is unavailable or has been deleted;

from line 121

116121

117122 - `deleted: boolean`

118123

124 default: false

125

119126 - `email_address: string or null`

120127

121128 - `name: string or null`

from line 129

122129

123130 - `type: "user_actor"`

124131

125 - `"user_actor"`

132 default: user_actor

126133

127134 - `user_id: string`

128135

from line 153

146153

147154 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.

148155

149 - `scope: object { type, user_id }`

156 - `scope: object`

150157

151158 - `type: "user"`

152159

153 - `"user"`

160 default: user

154161

155162 - `user_id: string`

156163

157 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`

164 - `source: object or object or object or 2 more`

158165

159 - `User object { type, user_id }`

166 - `User object`

160167

161168 - `type: "user"`

162169

163 - `"user"`

170 default: user

164171

165172 - `user_id: string`

166173

167 - `SeatTier object { seat_tier, type }`

174 - `SeatTier object`

168175

169176 - `seat_tier: string`

170177

171178 - `type: "seat_tier"`

172179

173 - `"seat_tier"`

180 default: seat_tier

174181

175 - `RbacGroup object { rbac_group_id, type }`

182 - `RbacGroup object`

176183

177184 - `rbac_group_id: string`

178185

179186 - `type: "rbac_group"`

180187

181 - `"rbac_group"`

188 default: rbac_group

182189

183 - `OrganizationService object { service, type }`

190 - `OrganizationService object`

184191

185192 - `service: string`

186193

187194 - `type: "organization_service"`

188195

189 - `"organization_service"`

196 default: organization_service

190197

191 - `Organization object { type }`

198 - `Organization object`

192199

193200 - `type: "organization"`

194201

195 - `"organization"`

202 default: organization

196203

197204 - `spend_limit_id: string`

198205

from line 213

206213

207214 - `type: "spend_limit_increase_request"`

208215

209 - `"spend_limit_increase_request"`

216 default: spend_limit_increase_request

210217

211218- `next_page: string or null`

212219

213### Example

220## Example

214221

215```http

222```bash

216223curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \

217224 -H 'anthropic-version: 2023-06-01' \

218225 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

219226```

220227

221#### Response

228### Response (200)

222229

223230```json

224231{

api/admin/spend_limits/increase_requests/retrieve Changed · +49 / -44 lines

# Get Spend Limit Increase Request ## Path parameters ## Returns ## Example ### Response (200) ## Get Spend Limit Increase Request ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Get Spend Limit Increase Request

3url: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/retrieve

4---

1# Get Spend Limit Increase Request

52

6## Get Spend Limit Increase Request

3**GET** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}`

74

8**get** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}`

9

105Retrieve a spend limit increase request.

116

127While `pending`, the response includes a live `spend_summary` for the

138requester at the request's period.

149

15### Path Parameters

10## Path parameters

1611

1712- `spend_limit_increase_request_id: string`

1813

1914 ID of the spend limit increase request.

2015

21### Returns

16## Returns

2217

23- `SpendLimitIncreaseRequest object { id, actor, created_at, 6 more }`

18- `SpendLimitIncreaseRequest object`

2419

2520 - `id: string`

2621

27 - `actor: object { deleted, email_address, name, 2 more }`

22 - `actor: object`

2823

2924 A user within the organization. `name` and `email_address` are

3025 null when the underlying account is unavailable or has been deleted;

from line 27

3227

3328 - `deleted: boolean`

3429

30 default: false

31

3532 - `email_address: string or null`

3633

3734 - `name: string or null`

from line 35

3835

3936 - `type: "user_actor"`

4037

41 - `"user_actor"`

38 default: user_actor

4239

4340 - `user_id: string`

4441

4542 - `created_at: string`

4643

44 format: date-time

45

4746 - `period: "daily" or "monthly" or "weekly"`

4847

4948 - `"daily"`

from line 53

5453

5554 - `resolved_at: string or null`

5655

57 - `resolved_by: object { deleted, email_address, name, 2 more } or object { scoped_api_key_id, type } or null`

56 format: date-time

5857

58 - `resolved_by: object or object or null`

59

5960 A user within the organization. `name` and `email_address` are

6061 null when the underlying account is unavailable or has been deleted;

6162 `deleted` is true only for deleted accounts.

6263

63 - `UserActor object { deleted, email_address, name, 2 more }`

64 - `UserActor object`

6465

6566 A user within the organization. `name` and `email_address` are

6667 null when the underlying account is unavailable or has been deleted;

from line 69

6869

6970 - `deleted: boolean`

7071

72 default: false

73

7174 - `email_address: string or null`

7275

7376 - `name: string or null`

from line 77

7477

7578 - `type: "user_actor"`

7679

77 - `"user_actor"`

80 default: user_actor

7881

7982 - `user_id: string`

8083

81 - `ScopedAPIKeyActor object { scoped_api_key_id, type }`

84 - `ScopedAPIKeyActor object`

8285

8386 A scoped Admin API key acting on behalf of the organization.

8487

from line 89

8689

8790 - `type: "scoped_api_key_actor"`

8891

89 - `"scoped_api_key_actor"`

92 default: scoped_api_key_actor

9093

9194 - `spend_summary: SpendSummary or null`

9295

9396 Per-member effective-limit report row (GET /spend_limits/effective).

9497

95 - `actor: object { deleted, email_address, name, 2 more }`

98 - `actor: object`

9699

97100 A user within the organization. `name` and `email_address` are

98101 null when the underlying account is unavailable or has been deleted;

from line 103

100103

101104 - `deleted: boolean`

102105

106 default: false

107

103108 - `email_address: string or null`

104109

105110 - `name: string or null`

from line 111

106111

107112 - `type: "user_actor"`

108113

109 - `"user_actor"`

114 default: user_actor

110115

111116 - `user_id: string`

112117

from line 135

130135

131136 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.

132137

133 - `scope: object { type, user_id }`

138 - `scope: object`

134139

135140 - `type: "user"`

136141

137 - `"user"`

142 default: user

138143

139144 - `user_id: string`

140145

141 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`

146 - `source: object or object or object or 2 more`

142147

143 - `User object { type, user_id }`

148 - `User object`

144149

145150 - `type: "user"`

146151

147 - `"user"`

152 default: user

148153

149154 - `user_id: string`

150155

151 - `SeatTier object { seat_tier, type }`

156 - `SeatTier object`

152157

153158 - `seat_tier: string`

154159

155160 - `type: "seat_tier"`

156161

157 - `"seat_tier"`

162 default: seat_tier

158163

159 - `RbacGroup object { rbac_group_id, type }`

164 - `RbacGroup object`

160165

161166 - `rbac_group_id: string`

162167

163168 - `type: "rbac_group"`

164169

165 - `"rbac_group"`

170 default: rbac_group

166171

167 - `OrganizationService object { service, type }`

172 - `OrganizationService object`

168173

169174 - `service: string`

170175

171176 - `type: "organization_service"`

172177

173 - `"organization_service"`

178 default: organization_service

174179

175 - `Organization object { type }`

180 - `Organization object`

176181

177182 - `type: "organization"`

178183

179 - `"organization"`

184 default: organization

180185

181186 - `spend_limit_id: string`

182187

from line 195

190195

191196 - `type: "spend_limit_increase_request"`

192197

193 - `"spend_limit_increase_request"`

198 default: spend_limit_increase_request

194199

195### Example

200## Example

196201

197```http

202```bash

198203curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \

199204 -H 'anthropic-version: 2023-06-01' \

200205 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

201206```

202207

203#### Response

208### Response (200)

204209

205210```json

206211{

api/admin/spend_limits/list_effective Changed · +30 / -27 lines

# List Effective Spend Limits ## Query parameters ## Returns ## Example ### Response (200) ## List Effective Spend Limits ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: List Effective Spend Limits

3url: https://platform.claude.com/docs/en/api/admin/spend_limits/list_effective

4---

1# List Effective Spend Limits

52

6## List Effective Spend Limits

3**GET** `/v1/organizations/spend_limits/effective`

74

8**get** `/v1/organizations/spend_limits/effective`

9

105List each member's effective spend limit and period-to-date spend.

116

127Returns one row per (member, period) the member resolves a spend limit

from line 8

138for, with the `source` scope the spend limit was inherited from.

149Paginates by member, so a member's periods never split across pages.

1510

16### Query Parameters

11## Query parameters

1712

1813- `limit: optional number`

1914

15 default: 20, maximum: 1000, minimum: 1

16

2017- `page: optional string`

2118

2219- `period: optional array of string`

2320

21 maxItems: 3

22

2423- `user_ids: optional array of string`

2524

26### Returns

25 maxItems: 100

2726

27## Returns

28

2829- `data: array of SpendSummary`

2930

30 - `actor: object { deleted, email_address, name, 2 more }`

31 - `actor: object`

3132

3233 A user within the organization. `name` and `email_address` are

3334 null when the underlying account is unavailable or has been deleted;

from line 36

3536

3637 - `deleted: boolean`

3738

39 default: false

40

3841 - `email_address: string or null`

3942

4043 - `name: string or null`

from line 44

4144

4245 - `type: "user_actor"`

4346

44 - `"user_actor"`

47 default: user_actor

4548

4649 - `user_id: string`

4750

from line 68

6568

6669 The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.

6770

68 - `scope: object { type, user_id }`

71 - `scope: object`

6972

7073 - `type: "user"`

7174

72 - `"user"`

75 default: user

7376

7477 - `user_id: string`

7578

76 - `source: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`

79 - `source: object or object or object or 2 more`

7780

78 - `User object { type, user_id }`

81 - `User object`

7982

8083 - `type: "user"`

8184

82 - `"user"`

85 default: user

8386

8487 - `user_id: string`

8588

86 - `SeatTier object { seat_tier, type }`

89 - `SeatTier object`

8790

8891 - `seat_tier: string`

8992

9093 - `type: "seat_tier"`

9194

92 - `"seat_tier"`

95 default: seat_tier

9396

94 - `RbacGroup object { rbac_group_id, type }`

97 - `RbacGroup object`

9598

9699 - `rbac_group_id: string`

97100

98101 - `type: "rbac_group"`

99102

100 - `"rbac_group"`

103 default: rbac_group

101104

102 - `OrganizationService object { service, type }`

105 - `OrganizationService object`

103106

104107 - `service: string`

105108

106109 - `type: "organization_service"`

107110

108 - `"organization_service"`

111 default: organization_service

109112

110 - `Organization object { type }`

113 - `Organization object`

111114

112115 - `type: "organization"`

113116

114 - `"organization"`

117 default: organization

115118

116119 - `spend_limit_id: string`

117120

118121- `next_page: string or null`

119122

120### Example

123## Example

121124

122```http

125```bash

123126curl https://api.anthropic.com/v1/organizations/spend_limits/effective \

124127 -H 'anthropic-version: 2023-06-01' \

125128 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

126129```

127130

128#### Response

131### Response (200)

129132

130133```json

131134{

api/admin/spend_limits/retrieve Changed · +24 / -25 lines

# Get Spend Limit ## Path parameters ## Returns ## Example ### Response (200) ## Get Spend Limit ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Get Spend Limit

3url: https://platform.claude.com/docs/en/api/admin/spend_limits/retrieve

4---

1# Get Spend Limit

52

6## Get Spend Limit

3**GET** `/v1/organizations/spend_limits/{spend_limit_id}`

74

8**get** `/v1/organizations/spend_limits/{spend_limit_id}`

9

105Retrieve a spend limit by ID.

116

12### Path Parameters

7## Path parameters

138

149- `spend_limit_id: string`

1510

1611 ID of the Spend Limit.

1712

18### Returns

13## Returns

1914

20- `SpendLimit object { id, amount, created_at, 5 more }`

15- `SpendLimit object`

2116

2217 - `id: string`

2318

from line 22

2722

2823 - `created_at: string`

2924

25 format: date-time

26

3027 - `currency: string`

3128

3229 ISO 4217 code of the organization's billing currency; the unit for `amount`.

from line 36

3936

4037 - `"weekly"`

4138

42 - `scope: object { type, user_id } or object { seat_tier, type } or object { rbac_group_id, type } or 2 more`

39 - `scope: object or object or object or 2 more`

4340

44 - `User object { type, user_id }`

41 - `User object`

4542

4643 - `type: "user"`

4744

48 - `"user"`

45 default: user

4946

5047 - `user_id: string`

5148

52 - `SeatTier object { seat_tier, type }`

49 - `SeatTier object`

5350

5451 - `seat_tier: string`

5552

5653 - `type: "seat_tier"`

5754

58 - `"seat_tier"`

55 default: seat_tier

5956

60 - `RbacGroup object { rbac_group_id, type }`

57 - `RbacGroup object`

6158

6259 - `rbac_group_id: string`

6360

6461 - `type: "rbac_group"`

6562

66 - `"rbac_group"`

63 default: rbac_group

6764

68 - `OrganizationService object { service, type }`

65 - `OrganizationService object`

6966

7067 - `service: string`

7168

7269 - `type: "organization_service"`

7370

74 - `"organization_service"`

71 default: organization_service

7572

76 - `Organization object { type }`

73 - `Organization object`

7774

7875 - `type: "organization"`

7976

80 - `"organization"`

77 default: organization

8178

8279 - `type: "spend_limit"`

8380

84 - `"spend_limit"`

81 default: spend_limit

8582

8683 - `updated_at: string`

8784

88### Example

85 format: date-time

8986

90```http

87## Example

88

89```bash

9190curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \

9291 -H 'anthropic-version: 2023-06-01' \

9392 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

9493```

9594

96#### Response

95### Response (200)

9796

9897```json

9998{

api/admin/usage_report Changed · +68 / -59 lines

### Query parameters ### Headers #### Response (200) ### Query parameters #### Response (200) ## Domain types ### Query Parameters ### Header Parameters #### Response ### Query Parameters #### Response ## Domain Types

from line 1

1---

2title: Usage Report

3url: https://platform.claude.com/docs/en/api/admin/usage_report

4---

5

61# Usage Report

72

83## Get Messages Usage Report

94

10**get** `/v1/organizations/usage_report/messages`

5**GET** `/v1/organizations/usage_report/messages`

116

127Get Messages Usage Report

138

14### Query Parameters

9### Query parameters

1510

1611- `starting_at: string`

1712

from line 13

1813 Time buckets that start on or after this RFC 3339 timestamp will be returned.

1914 Each time bucket will be snapped to the start of the minute/hour/day in UTC.

2015

16 format: date-time

17

2118- `account_ids: optional array of string`

2219

2320 Restrict usage returned to the specified user account ID(s).

from line 27

3027

3128 Time granularity of the response data.

3229

30 default: 1d

31

3332 - `"1d"`

3433

3534 - `"1h"`

from line 47

4847

4948 Time buckets that end before this RFC 3339 timestamp will be returned.

5049

50 format: date-time

51

5152- `group_by: optional array of "account_id" or "api_key_id" or "context_window" or 6 more`

5253

5354 Group by any subset of the available options. Grouping by `speed` requires the `fast-mode-2026-02-01` beta header.

from line 131

130131

131132 Restrict usage returned to the specified workspace ID(s).

132133

133### Header Parameters

134### Headers

134135

135136- `"anthropic-beta": optional array of string`

136137

from line 141

140141

141142### Returns

142143

143- `MessagesUsageReport object { data, has_more, next_page }`

144- `MessagesUsageReport object`

144145

145 - `data: array of object { ending_at, results, starting_at }`

146 - `data: array of object`

146147

147148 List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets.

148149

from line 151

150151

151152 End of the time bucket (exclusive) in RFC 3339 format.

152153

153 - `results: array of object { account_id, api_key_id, cache_creation, 10 more }`

154 format: date-time

154155

156 - `results: array of object`

157

155158 List of usage items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified.

156159

157160 - `account_id: string or null`

from line 165

162165

163166 ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console.

164167

165 - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }`

168 - `cache_creation: object`

166169

167170 The number of input tokens for cache creation.

168171

from line 208

205208

206209 The number of output tokens generated.

207210

208 - `server_tool_use: object { web_search_requests }`

211 - `server_tool_use: object`

209212

210213 Server-side tool usage metrics.

211214

from line 248

245248

246249 Start of the time bucket (inclusive) in RFC 3339 format.

247250

251 format: date-time

252

248253 - `has_more: boolean`

249254

250255 Indicates if there are more results.

from line 260

255260

256261### Example

257262

258```http

263```bash

259264curl https://api.anthropic.com/v1/organizations/usage_report/messages \

260265 -H 'anthropic-version: 2023-06-01' \

261266 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

262267```

263268

264#### Response

269#### Response (200)

265270

266271```json

267272{

from line 305

300305

301306## Get Claude Code Usage Report

302307

303**get** `/v1/organizations/usage_report/claude_code`

308**GET** `/v1/organizations/usage_report/claude_code`

304309

305310Retrieve daily aggregated usage metrics for Claude Code users.

306311Enables organizations to analyze developer productivity and build custom dashboards.

307312

308### Query Parameters

313### Query parameters

309314

310315- `starting_at: string`

311316

312317 UTC date in YYYY-MM-DD format. Returns metrics for this single day only.

313318

319 pattern: ^\d{4}-\d{2}-\d{2}$

320

314321- `limit: optional number`

315322

316323 Number of records per page (default: 20, max: 1000).

317324

325 default: 20, maximum: 1000, minimum: 1

326

318327- `page: optional string`

319328

320329 Opaque cursor token from previous response's `next_page` field.

from line 330

321330

322331### Returns

323332

324- `ClaudeCodeUsageReport object { data, has_more, next_page }`

333- `ClaudeCodeUsageReport object`

325334

326 - `data: array of object { actor, core_metrics, customer_type, 7 more }`

335 - `data: array of object`

327336

328337 List of Claude Code usage records for the requested date.

329338

330 - `actor: object { email_address, type } or object { api_key_name, type }`

339 - `actor: object or object`

331340

332341 The user or API key that performed the Claude Code actions.

333342

334 - `UserActor object { email_address, type }`

343 - `UserActor object`

335344

336345 - `email_address: string`

337346

from line 350

341350

342351 Actor type. Always `"user_actor"` for a user.

343352

344 - `"user_actor"`

353 - `APIActor object`

345354

346 - `APIActor object { api_key_name, type }`

347

348355 - `api_key_name: string`

349356

350357 Name of the API key used to perform Claude Code actions.

from line 360

353360

354361 Actor type. Always `"api_actor"` for an API key.

355362

356 - `"api_actor"`

363 - `core_metrics: object`

357364

358 - `core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }`

359

360365 Core productivity metrics measuring Claude Code usage and impact.

361366

362367 - `commits_by_claude_code: number`

from line 368

363368

364369 Number of git commits created through Claude Code's commit functionality.

365370

366 - `lines_of_code: object { added, removed }`

371 - `lines_of_code: object`

367372

368373 Statistics on code changes made through Claude Code.

369374

from line 401

396401 UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC

397402 (for example `2025-08-08T00:00:00Z`).

398403

404 format: date-time

405

399406 - `is_remote: boolean`

400407

401408 Whether the usage came from remote Claude Code sessions, such as Claude Code

402409 on the web. Remote and local usage are reported as separate rows.

403410

404 - `model_breakdown: array of object { estimated_cost, model, tokens }`

411 - `model_breakdown: array of object`

405412

406413 Token usage and cost breakdown by AI model used.

407414

408 - `estimated_cost: object { amount, currency }`

415 - `estimated_cost: object`

409416

410417 Estimated cost for using this model

411418

from line 428

421428

422429 Name of the AI model used for Claude Code interactions.

423430

424 - `tokens: object { cache_creation, cache_read, input, output }`

431 - `tokens: object`

425432

426433 Token usage breakdown for this model

427434

from line 456

449456

450457 Type of terminal or environment where Claude Code was used.

451458

452 - `tool_actions: map[object { accepted, rejected } ]`

459 - `tool_actions: map[object]`

453460

454461 Breakdown of tool action acceptance and rejection rates by tool type.

455462

from line 486

479486

480487### Example

481488

482```http

489```bash

483490curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \

484491 -H 'anthropic-version: 2023-06-01' \

485492 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

486493```

487494

488#### Response

495#### Response (200)

489496

490497```json

491498{

from line 570

563570}

564571```

565572

566## Domain Types

573## Domain types

567574

568575### Claude Code Usage Report

569576

570- `ClaudeCodeUsageReport object { data, has_more, next_page }`

577- `ClaudeCodeUsageReport object`

571578

572 - `data: array of object { actor, core_metrics, customer_type, 7 more }`

579 - `data: array of object`

573580

574581 List of Claude Code usage records for the requested date.

575582

576 - `actor: object { email_address, type } or object { api_key_name, type }`

583 - `actor: object or object`

577584

578585 The user or API key that performed the Claude Code actions.

579586

580 - `UserActor object { email_address, type }`

587 - `UserActor object`

581588

582589 - `email_address: string`

583590

from line 594

587594

588595 Actor type. Always `"user_actor"` for a user.

589596

590 - `"user_actor"`

597 - `APIActor object`

591598

592 - `APIActor object { api_key_name, type }`

593

594599 - `api_key_name: string`

595600

596601 Name of the API key used to perform Claude Code actions.

from line 604

599604

600605 Actor type. Always `"api_actor"` for an API key.

601606

602 - `"api_actor"`

607 - `core_metrics: object`

603608

604 - `core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }`

605

606609 Core productivity metrics measuring Claude Code usage and impact.

607610

608611 - `commits_by_claude_code: number`

from line 612

609612

610613 Number of git commits created through Claude Code's commit functionality.

611614

612 - `lines_of_code: object { added, removed }`

615 - `lines_of_code: object`

613616

614617 Statistics on code changes made through Claude Code.

615618

from line 645

642645 UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC

643646 (for example `2025-08-08T00:00:00Z`).

644647

648 format: date-time

649

645650 - `is_remote: boolean`

646651

647652 Whether the usage came from remote Claude Code sessions, such as Claude Code

648653 on the web. Remote and local usage are reported as separate rows.

649654

650 - `model_breakdown: array of object { estimated_cost, model, tokens }`

655 - `model_breakdown: array of object`

651656

652657 Token usage and cost breakdown by AI model used.

653658

654 - `estimated_cost: object { amount, currency }`

659 - `estimated_cost: object`

655660

656661 Estimated cost for using this model

657662

from line 672

667672

668673 Name of the AI model used for Claude Code interactions.

669674

670 - `tokens: object { cache_creation, cache_read, input, output }`

675 - `tokens: object`

671676

672677 Token usage breakdown for this model

673678

from line 700

695700

696701 Type of terminal or environment where Claude Code was used.

697702

698 - `tool_actions: map[object { accepted, rejected } ]`

703 - `tool_actions: map[object]`

699704

700705 Breakdown of tool action acceptance and rejection rates by tool type.

701706

from line 730

725730

726731### Messages Usage Report

727732

728- `MessagesUsageReport object { data, has_more, next_page }`

733- `MessagesUsageReport object`

729734

730 - `data: array of object { ending_at, results, starting_at }`

735 - `data: array of object`

731736

732737 List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets.

733738

from line 740

735740

736741 End of the time bucket (exclusive) in RFC 3339 format.

737742

738 - `results: array of object { account_id, api_key_id, cache_creation, 10 more }`

743 format: date-time

739744

745 - `results: array of object`

746

740747 List of usage items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified.

741748

742749 - `account_id: string or null`

from line 754

747754

748755 ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console.

749756

750 - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }`

757 - `cache_creation: object`

751758

752759 The number of input tokens for cache creation.

753760

from line 797

790797

791798 The number of output tokens generated.

792799

793 - `server_tool_use: object { web_search_requests }`

800 - `server_tool_use: object`

794801

795802 Server-side tool usage metrics.

796803

from line 836

829836 - `starting_at: string`

830837

831838 Start of the time bucket (inclusive) in RFC 3339 format.

839

840 format: date-time

832841

833842 - `has_more: boolean`

834843

api/admin/usage_report/retrieve_claude_code Changed · +28 / -31 lines

# Get Claude Code Usage Report ## Query parameters ## Returns ## Example ### Response (200) ## Get Claude Code Usage Report ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Get Claude Code Usage Report

3url: https://platform.claude.com/docs/en/api/admin/usage_report/retrieve_claude_code

4---

1# Get Claude Code Usage Report

52

6## Get Claude Code Usage Report

3**GET** `/v1/organizations/usage_report/claude_code`

74

8**get** `/v1/organizations/usage_report/claude_code`

9

105Retrieve daily aggregated usage metrics for Claude Code users.

116Enables organizations to analyze developer productivity and build custom dashboards.

127

13### Query Parameters

8## Query parameters

149

1510- `starting_at: string`

1611

1712 UTC date in YYYY-MM-DD format. Returns metrics for this single day only.

1813

14 pattern: ^\d{4}-\d{2}-\d{2}$

15

1916- `limit: optional number`

2017

2118 Number of records per page (default: 20, max: 1000).

2219

20 default: 20, maximum: 1000, minimum: 1

21

2322- `page: optional string`

2423

2524 Opaque cursor token from previous response's `next_page` field.

2625

27### Returns

26## Returns

2827

29- `ClaudeCodeUsageReport object { data, has_more, next_page }`

28- `ClaudeCodeUsageReport object`

3029

31 - `data: array of object { actor, core_metrics, customer_type, 7 more }`

30 - `data: array of object`

3231

3332 List of Claude Code usage records for the requested date.

3433

35 - `actor: object { email_address, type } or object { api_key_name, type }`

34 - `actor: object or object`

3635

3736 The user or API key that performed the Claude Code actions.

3837

39 - `UserActor object { email_address, type }`

38 - `UserActor object`

4039

4140 - `email_address: string`

4241

from line 45

4645

4746 Actor type. Always `"user_actor"` for a user.

4847

49 - `"user_actor"`

48 - `APIActor object`

5049

51 - `APIActor object { api_key_name, type }`

52

5350 - `api_key_name: string`

5451

5552 Name of the API key used to perform Claude Code actions.

from line 55

5855

5956 Actor type. Always `"api_actor"` for an API key.

6057

61 - `"api_actor"`

58 - `core_metrics: object`

6259

63 - `core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }`

64

6560 Core productivity metrics measuring Claude Code usage and impact.

6661

6762 - `commits_by_claude_code: number`

from line 63

6863

6964 Number of git commits created through Claude Code's commit functionality.

7065

71 - `lines_of_code: object { added, removed }`

66 - `lines_of_code: object`

7267

7368 Statistics on code changes made through Claude Code.

7469

from line 96

10196 UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC

10297 (for example `2025-08-08T00:00:00Z`).

10398

99 format: date-time

100

104101 - `is_remote: boolean`

105102

106103 Whether the usage came from remote Claude Code sessions, such as Claude Code

107104 on the web. Remote and local usage are reported as separate rows.

108105

109 - `model_breakdown: array of object { estimated_cost, model, tokens }`

106 - `model_breakdown: array of object`

110107

111108 Token usage and cost breakdown by AI model used.

112109

113 - `estimated_cost: object { amount, currency }`

110 - `estimated_cost: object`

114111

115112 Estimated cost for using this model

116113

from line 123

126123

127124 Name of the AI model used for Claude Code interactions.

128125

129 - `tokens: object { cache_creation, cache_read, input, output }`

126 - `tokens: object`

130127

131128 Token usage breakdown for this model

132129

from line 151

154151

155152 Type of terminal or environment where Claude Code was used.

156153

157 - `tool_actions: map[object { accepted, rejected } ]`

154 - `tool_actions: map[object]`

158155

159156 Breakdown of tool action acceptance and rejection rates by tool type.

160157

from line 179

182179

183180 Opaque cursor token for fetching the next page of results, or null if no more pages are available.

184181

185### Example

182## Example

186183

187```http

184```bash

188185curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \

189186 -H 'anthropic-version: 2023-06-01' \

190187 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

191188```

192189

193#### Response

190### Response (200)

194191

195192```json

196193{

api/admin/usage_report/retrieve_messages Changed · +27 / -22 lines

# Get Messages Usage Report ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## Get Messages Usage Report ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Get Messages Usage Report

3url: https://platform.claude.com/docs/en/api/admin/usage_report/retrieve_messages

4---

1# Get Messages Usage Report

52

6## Get Messages Usage Report

3**GET** `/v1/organizations/usage_report/messages`

74

8**get** `/v1/organizations/usage_report/messages`

9

105Get Messages Usage Report

116

12### Query Parameters

7## Query parameters

138

149- `starting_at: string`

1510

from line 11

1611 Time buckets that start on or after this RFC 3339 timestamp will be returned.

1712 Each time bucket will be snapped to the start of the minute/hour/day in UTC.

1813

14 format: date-time

15

1916- `account_ids: optional array of string`

2017

2118 Restrict usage returned to the specified user account ID(s).

from line 25

2825

2926 Time granularity of the response data.

3027

28 default: 1d

29

3130 - `"1d"`

3231

3332 - `"1h"`

from line 45

4645

4746 Time buckets that end before this RFC 3339 timestamp will be returned.

4847

48 format: date-time

49

4950- `group_by: optional array of "account_id" or "api_key_id" or "context_window" or 6 more`

5051

5152 Group by any subset of the available options. Grouping by `speed` requires the `fast-mode-2026-02-01` beta header.

from line 129

128129

129130 Restrict usage returned to the specified workspace ID(s).

130131

131### Header Parameters

132## Headers

132133

133134- `"anthropic-beta": optional array of string`

134135

from line 137

136137

137138 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

138139

139### Returns

140## Returns

140141

141- `MessagesUsageReport object { data, has_more, next_page }`

142- `MessagesUsageReport object`

142143

143 - `data: array of object { ending_at, results, starting_at }`

144 - `data: array of object`

144145

145146 List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets.

146147

from line 149

148149

149150 End of the time bucket (exclusive) in RFC 3339 format.

150151

151 - `results: array of object { account_id, api_key_id, cache_creation, 10 more }`

152 format: date-time

152153

154 - `results: array of object`

155

153156 List of usage items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified.

154157

155158 - `account_id: string or null`

from line 163

160163

161164 ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console.

162165

163 - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }`

166 - `cache_creation: object`

164167

165168 The number of input tokens for cache creation.

166169

from line 206

203206

204207 The number of output tokens generated.

205208

206 - `server_tool_use: object { web_search_requests }`

209 - `server_tool_use: object`

207210

208211 Server-side tool usage metrics.

209212

from line 246

243246

244247 Start of the time bucket (inclusive) in RFC 3339 format.

245248

249 format: date-time

250

246251 - `has_more: boolean`

247252

248253 Indicates if there are more results.

from line 256

251256

252257 Opaque cursor for the next page, or `null` when `has_more` is false. Pass it as the `page` parameter in the next request.

253258

254### Example

259## Example

255260

256```http

261```bash

257262curl https://api.anthropic.com/v1/organizations/usage_report/messages \

258263 -H 'anthropic-version: 2023-06-01' \

259264 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

260265```

261266

262#### Response

267### Response (200)

263268

264269```json

265270{

api/admin/users Changed · +40 / -33 lines

### Path parameters #### Response (200) ### Query parameters #### Response (200) ### Path parameters ### Body parameters #### Response (200) ### Path parameters #### Response (200) ## Domain types ### Path Parameters #### Response ### Query Parameters #### Response ### Path Parameters ### Body Parameters #### Response ### Path Parameters #### Response ## Domain Types

from line 1

1---

2title: Users

3url: https://platform.claude.com/docs/en/api/admin/users

4---

5

61# Users

72

83## Get User

94

10**get** `/v1/organizations/users/{user_id}`

5**GET** `/v1/organizations/users/{user_id}`

116

127For Claude Enterprise organizations, this endpoint's availability is in beta.

138

14### Path Parameters

9### Path parameters

1510

1611- `user_id: string`

1712

from line 14

1914

2015### Returns

2116

22- `User object { id, added_at, email, 3 more }`

17- `User object`

2318

2419 - `id: string`

2520

from line 24

2924

3025 RFC 3339 datetime string indicating when the User joined the Organization.

3126

27 format: date-time

28

3229 - `email: string`

3330

3431 Email of the User.

from line 62

6562

6663 For Users, this is always `"user"`.

6764

68 - `"user"`

65 default: user

6966

7067### Example

7168

72```http

69```bash

7370curl https://api.anthropic.com/v1/organizations/users/$USER_ID \

7471 -H 'anthropic-version: 2023-06-01' \

7572 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

7673```

7774

78#### Response

75#### Response (200)

7976

8077```json

8178{

from line 87

9087

9188## List Users

9289

93**get** `/v1/organizations/users`

90**GET** `/v1/organizations/users`

9491

9592For Claude Enterprise organizations, this endpoint's availability is in beta.

9693

97### Query Parameters

94### Query parameters

9895

9996- `after_id: optional string`

10097

from line 105

108105

109106 Filter by user email.

110107

108 format: email

109

111110- `limit: optional number`

112111

113112 Number of items to return per page.

from line 113

114113

115114 Defaults to `20`. Ranges from `1` to `1000`.

116115

116 default: 20, maximum: 1000, minimum: 1

117

117118- `roles: optional array of string`

118119

119120 Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.

from line 133

132133

133134 RFC 3339 datetime string indicating when the User joined the Organization.

134135

136 format: date-time

137

135138 - `email: string`

136139

137140 Email of the User.

from line 171

168171

169172 For Users, this is always `"user"`.

170173

171 - `"user"`

174 default: user

172175

173176- `first_id: string or null`

174177

from line 187

184187

185188### Example

186189

187```http

190```bash

188191curl https://api.anthropic.com/v1/organizations/users \

189192 -H 'anthropic-version: 2023-06-01' \

190193 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

191194```

192195

193#### Response

196#### Response (200)

194197

195198```json

196199{

from line 215

212215

213216## Update User

214217

215**post** `/v1/organizations/users/{user_id}`

218**POST** `/v1/organizations/users/{user_id}`

216219

217220For Claude Enterprise organizations, this endpoint's availability is in beta.

218221

219### Path Parameters

222### Path parameters

220223

221224- `user_id: string`

222225

223226 ID of the User.

224227

225### Body Parameters

228### Body parameters

226229

227230- `role: "billing" or "claude_code_user" or "developer" or 2 more`

228231

from line 245

242245

243246### Returns

244247

245- `User object { id, added_at, email, 3 more }`

248- `User object`

246249

247250 - `id: string`

248251

from line 255

252255

253256 RFC 3339 datetime string indicating when the User joined the Organization.

254257

258 format: date-time

259

255260 - `email: string`

256261

257262 Email of the User.

from line 293

288293

289294 For Users, this is always `"user"`.

290295

291 - `"user"`

296 default: user

292297

293298### Example

294299

295```http

300```bash

296301curl https://api.anthropic.com/v1/organizations/users/$USER_ID \

297302 -H 'Content-Type: application/json' \

298303 -H 'anthropic-version: 2023-06-01' \

from line 307

302307 }'

303308```

304309

305#### Response

310#### Response (200)

306311

307312```json

308313{

from line 322

317322

318323## Remove User

319324

320**delete** `/v1/organizations/users/{user_id}`

325**DELETE** `/v1/organizations/users/{user_id}`

321326

322327For Claude Enterprise organizations, this endpoint's availability is in beta.

323328

324### Path Parameters

329### Path parameters

325330

326331- `user_id: string`

327332

from line 344

339344

340345 For Users, this is always `"user_deleted"`.

341346

342 - `"user_deleted"`

347 default: user_deleted

343348

344349### Example

345350

346```http

351```bash

347352curl https://api.anthropic.com/v1/organizations/users/$USER_ID \

348353 -X DELETE \

349354 -H 'anthropic-version: 2023-06-01' \

from line 355

350355 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

351356```

352357

353#### Response

358#### Response (200)

354359

355360```json

356361{

from line 364

359364}

360365```

361366

362## Domain Types

367## Domain types

363368

364369### User

365370

366- `User object { id, added_at, email, 3 more }`

371- `User object`

367372

368373 - `id: string`

369374

from line 378

373378

374379 RFC 3339 datetime string indicating when the User joined the Organization.

375380

381 format: date-time

382

376383 - `email: string`

377384

378385 Email of the User.

from line 416

409416

410417 For Users, this is always `"user"`.

411418

412 - `"user"`

419 default: user

413420

414421### User Delete Response

415422

416- `UserDeleteResponse object { id, type }`

423- `UserDeleteResponse object`

417424

418425 - `id: string`

419426

from line 432

425432

426433 For Users, this is always `"user_deleted"`.

427434

428 - `"user_deleted"`

435 default: user_deleted

429436

api/admin/users/delete Changed · +8 / -13 lines

# Remove User ## Path parameters ## Returns ## Example ### Response (200) ## Remove User ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Remove User

3url: https://platform.claude.com/docs/en/api/admin/users/delete

4---

1# Remove User

52

6## Remove User

3**DELETE** `/v1/organizations/users/{user_id}`

74

8**delete** `/v1/organizations/users/{user_id}`

9

105For Claude Enterprise organizations, this endpoint's availability is in beta.

116

12### Path Parameters

7## Path parameters

138

149- `user_id: string`

1510

1611 ID of the User.

1712

18### Returns

13## Returns

1914

2015- `id: string`

2116

from line 22

2722

2823 For Users, this is always `"user_deleted"`.

2924

30 - `"user_deleted"`

25 default: user_deleted

3126

32### Example

27## Example

3328

34```http

29```bash

3530curl https://api.anthropic.com/v1/organizations/users/$USER_ID \

3631 -X DELETE \

3732 -H 'anthropic-version: 2023-06-01' \

from line 33

3833 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

3934```

4035

41#### Response

36### Response (200)

4237

4338```json

4439{

api/admin/users/list Changed · +14 / -13 lines

# List Users ## Query parameters ## Returns ## Example ### Response (200) ## List Users ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: List Users

3url: https://platform.claude.com/docs/en/api/admin/users/list

4---

1# List Users

52

6## List Users

3**GET** `/v1/organizations/users`

74

8**get** `/v1/organizations/users`

9

105For Claude Enterprise organizations, this endpoint's availability is in beta.

116

12### Query Parameters

7## Query parameters

138

149- `after_id: optional string`

1510

from line 18

2318

2419 Filter by user email.

2520

21 format: email

22

2623- `limit: optional number`

2724

2825 Number of items to return per page.

from line 26

2926

3027 Defaults to `20`. Ranges from `1` to `1000`.

3128

29 default: 20, maximum: 1000, minimum: 1

30

3231- `roles: optional array of string`

3332

3433 Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.

from line 34

3534

3635 Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations (beta) accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.

3736

38### Returns

37## Returns

3938

4039- `data: array of User`

4140

from line 46

4746

4847 RFC 3339 datetime string indicating when the User joined the Organization.

4948

49 format: date-time

50

5051 - `email: string`

5152

5253 Email of the User.

from line 84

8384

8485 For Users, this is always `"user"`.

8586

86 - `"user"`

87 default: user

8788

8889- `first_id: string or null`

8990

from line 98

9798

9899 Last ID in the `data` list. Can be used as the `after_id` for the next page.

99100

100### Example

101## Example

101102

102```http

103```bash

103104curl https://api.anthropic.com/v1/organizations/users \

104105 -H 'anthropic-version: 2023-06-01' \

105106 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

106107```

107108

108#### Response

109### Response (200)

109110

110111```json

111112{

api/admin/users/retrieve Changed · +11 / -14 lines

# Get User ## Path parameters ## Returns ## Example ### Response (200) ## Get User ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Get User

3url: https://platform.claude.com/docs/en/api/admin/users/retrieve

4---

1# Get User

52

6## Get User

3**GET** `/v1/organizations/users/{user_id}`

74

8**get** `/v1/organizations/users/{user_id}`

9

105For Claude Enterprise organizations, this endpoint's availability is in beta.

116

12### Path Parameters

7## Path parameters

138

149- `user_id: string`

1510

1611 ID of the User.

1712

18### Returns

13## Returns

1914

20- `User object { id, added_at, email, 3 more }`

15- `User object`

2116

2217 - `id: string`

2318

from line 22

2722

2823 RFC 3339 datetime string indicating when the User joined the Organization.

2924

25 format: date-time

26

3027 - `email: string`

3128

3229 Email of the User.

from line 60

6360

6461 For Users, this is always `"user"`.

6562

66 - `"user"`

63 default: user

6764

68### Example

65## Example

6966

70```http

67```bash

7168curl https://api.anthropic.com/v1/organizations/users/$USER_ID \

7269 -H 'anthropic-version: 2023-06-01' \

7370 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

7471```

7572

76#### Response

73### Response (200)

7774

7875```json

7976{

api/admin/users/update Changed · +12 / -15 lines

# Update User ## Path parameters ## Body parameters ## Returns ## Example ### Response (200) ## Update User ### Path Parameters ### Body Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Update User

3url: https://platform.claude.com/docs/en/api/admin/users/update

4---

1# Update User

52

6## Update User

3**POST** `/v1/organizations/users/{user_id}`

74

8**post** `/v1/organizations/users/{user_id}`

9

105For Claude Enterprise organizations, this endpoint's availability is in beta.

116

12### Path Parameters

7## Path parameters

138

149- `user_id: string`

1510

1611 ID of the User.

1712

18### Body Parameters

13## Body parameters

1914

2015- `role: "billing" or "claude_code_user" or "developer" or 2 more`

2116

from line 28

3328

3429 - `"user"`

3530

36### Returns

31## Returns

3732

38- `User object { id, added_at, email, 3 more }`

33- `User object`

3934

4035 - `id: string`

4136

from line 40

4540

4641 RFC 3339 datetime string indicating when the User joined the Organization.

4742

43 format: date-time

44

4845 - `email: string`

4946

5047 Email of the User.

from line 78

8178

8279 For Users, this is always `"user"`.

8380

84 - `"user"`

81 default: user

8582

86### Example

83## Example

8784

88```http

85```bash

8986curl https://api.anthropic.com/v1/organizations/users/$USER_ID \

9087 -H 'Content-Type: application/json' \

9188 -H 'anthropic-version: 2023-06-01' \

from line 92

9592 }'

9693```

9794

98#### Response

95### Response (200)

9996

10097```json

10198{

api/admin/workspaces Changed · +213 / -492 lines

### Headers ### Body parameters #### Response (200) ### Path parameters #### Response (200) ### Query parameters #### Response (200) ### Path parameters ### Body parameters #### Response (200) ### Path parameters #### Response (200) ## Workspaces › Members ### Create Workspace Member #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Get Workspace Member #### Path parameters #### Returns #### Example ##### Response (200) ### List Workspace Members #### Path parameters #### Query parameters #### Returns #### Example ##### Response (200) ### Update Workspace Member #### Path parameters #### Body parameters #### Returns #### Example ##### Response (200) ### Delete Workspace Member #### Path parameters #### Returns #### Example ##### Response (200) ## Workspaces › Rate Limits ### List Workspace Rate Limits #### Path parameters #### Query parameters #### Returns #### Example ##### Response (200) ## Workspaces › Service Accounts ### Create Service Account Workspace Member #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### Get Service Account Workspace Member #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### List Service Account Workspace Members #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Update Service Account Workspace Member #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### Delete Service Account Workspace Member #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### Header Parameters ### Body Parameters #### Response ### Path Parameters #### Response ### Query Parameters #### Response ### Path Parameters ### Body Parameters #### Response ### Path Parameters #### Response # Members ## Create Workspace Member ### Path Parameters ### Body Parameters #### Response ## Get Workspace Member ### Path Parameters #### Response ## List Workspace Members ### Path Parameters ### Query Parameters #### Response ## Update Workspace Member ### Path Parameters ### Body Parameters #### Response ## Delete Workspace Member ### Path Parameters #### Response ## Domain Types ### Workspace Member ### Member Delete Response # Rate Limits ## List Workspace Rate Limits ### Path Parameters ### Query Parameters #### Response ## Domain Types ### Rate Limit List Response # Service Accounts ## Create Service Account Workspace Member ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## Get Service Account Workspace Member ### Path Parameters ### Header Parameters #### Response ## List Service Account Workspace Members ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Update Service Account Workspace Member ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## Delete Service Account Workspace Member ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Service Account Create Response ### Service Account Retrieve Response ### Service Account List Response ### Service Account Update Response ### Service Account Delete Response

The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.

from line 1

1---

2title: Workspaces

3url: https://platform.claude.com/docs/en/api/admin/workspaces

4---

5

61# Workspaces

72

83## Create Workspace

94

10**post** `/v1/organizations/workspaces`

5**POST** `/v1/organizations/workspaces`

116

127Create Workspace

138

14### Header Parameters

9### Headers

1510

1611- `"anthropic-beta": optional array of string`

1712

from line 14

1914

2015 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

2116

22### Body Parameters

17### Body parameters

2318

2419- `name: string`

2520

2621 Name of the Workspace.

2722

28- `data_residency: optional object { allowed_inference_geos, default_inference_geo, workspace_geo } or null`

23 maxLength: 40, minLength: 1

24

25- `data_residency: optional object or null`

2926

3027 Data residency configuration for the workspace. If omitted, defaults to workspace_geo=`"us"`, allowed_inference_geos=`"unrestricted"`, and default_inference_geo=`"global"`.

3128

from line 38

4138

4239 - `"unrestricted"`

4340

44 - `"unrestricted"`

45

4641 - `default_inference_geo: optional "global" or "us" or null`

4742

4843 Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is `"unrestricted"`.

from line 49

5449 - `workspace_geo: optional "us" or null`

5550

5651 Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

57

58 - `"us"`

5952

6053- `external_key_id: optional string or null`

6154

from line 66

7366

7467### Returns

7568

76- `Workspace object { id, archived_at, compartment_id, 7 more }`

69- `Workspace object`

7770

7871 - `id: string`

7972

from line 75

8275 - `archived_at: string or null`

8376

8477 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

78

79 format: date-time

8580

8681 - `compartment_id: string`

8782

from line 91

9691

9792 RFC 3339 datetime string indicating when the Workspace was created.

9893

99 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

94 format: date-time

95

96 - `data_residency: object`

10097

10198 Data residency configuration.

10299

from line 104

107104 - `array of string`

108105

109106 - `"unrestricted"`

110

111 - `"unrestricted"`

112107

113108 - `default_inference_geo: string`

114109

from line 141

146141

147142 For Workspaces, this is always `"workspace"`.

148143

149 - `"workspace"`

144 default: workspace

150145

151146### Example

152147

153```http

148```bash

154149curl https://api.anthropic.com/v1/organizations/workspaces \

155150 -H 'Content-Type: application/json' \

156151 -H 'anthropic-version: 2023-06-01' \

from line 160

165160 }'

166161```

167162

168#### Response

163#### Response (200)

169164

170165```json

171166{

from line 186

191186

192187## Get Workspace

193188

194**get** `/v1/organizations/workspaces/{workspace_id}`

189**GET** `/v1/organizations/workspaces/{workspace_id}`

195190

196191Get Workspace

197192

198### Path Parameters

193### Path parameters

199194

200195- `workspace_id: string`

201196

from line 198

203198

204199### Returns

205200

206- `Workspace object { id, archived_at, compartment_id, 7 more }`

201- `Workspace object`

207202

208203 - `id: string`

209204

from line 207

212207 - `archived_at: string or null`

213208

214209 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

210

211 format: date-time

215212

216213 - `compartment_id: string`

217214

from line 223

226223

227224 RFC 3339 datetime string indicating when the Workspace was created.

228225

229 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

226 format: date-time

227

228 - `data_residency: object`

230229

231230 Data residency configuration.

232231

from line 236

237236 - `array of string`

238237

239238 - `"unrestricted"`

240

241 - `"unrestricted"`

242239

243240 - `default_inference_geo: string`

244241

from line 273

276273

277274 For Workspaces, this is always `"workspace"`.

278275

279 - `"workspace"`

276 default: workspace

280277

281278### Example

282279

283```http

280```bash

284281curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \

285282 -H 'anthropic-version: 2023-06-01' \

286283 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

287284```

288285

289#### Response

286#### Response (200)

290287

291288```json

292289{

from line 309

312309

313310## List Workspaces

314311

315**get** `/v1/organizations/workspaces`

312**GET** `/v1/organizations/workspaces`

316313

317314List Workspaces

318315

319### Query Parameters

316### Query parameters

320317

321318- `after_id: optional string`

322319

from line 327

330327

331328 Whether to include Workspaces that have been archived in the response

332329

330 default: false

331

333332- `limit: optional number`

334333

335334 Number of items to return per page.

336335

337336 Defaults to `20`. Ranges from `1` to `1000`.

338337

338 default: 20, maximum: 1000, minimum: 1

339

339340### Returns

340341

341342- `data: array of Workspace`

from line 348

347348 - `archived_at: string or null`

348349

349350 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

351

352 format: date-time

350353

351354 - `compartment_id: string`

352355

from line 364

361364

362365 RFC 3339 datetime string indicating when the Workspace was created.

363366

364 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

367 format: date-time

368

369 - `data_residency: object`

365370

366371 Data residency configuration.

367372

from line 377

372377 - `array of string`

373378

374379 - `"unrestricted"`

375

376 - `"unrestricted"`

377380

378381 - `default_inference_geo: string`

379382

from line 414

411414

412415 For Workspaces, this is always `"workspace"`.

413416

414 - `"workspace"`

417 default: workspace

415418

416419- `first_id: string or null`

417420

from line 430

427430

428431### Example

429432

430```http

433```bash

431434curl https://api.anthropic.com/v1/organizations/workspaces \

432435 -H 'anthropic-version: 2023-06-01' \

433436 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

434437```

435438

436#### Response

439#### Response (200)

437440

438441```json

439442{

from line 469

466469

467470## Update Workspace

468471

469**post** `/v1/organizations/workspaces/{workspace_id}`

472**POST** `/v1/organizations/workspaces/{workspace_id}`

470473

471474Update Workspace

472475

473### Path Parameters

474

475- `workspace_id: string`

476

477### Body Parameters

478

479- `data_residency: optional object { allowed_inference_geos, default_inference_geo } or null`

476### Path parameters

477

478- `workspace_id: string`

479

480### Body parameters

481

482- `data_residency: optional object or null`

480483

481484 Data residency configuration for the workspace.

482485

from line 494

491494 - `"us"`

492495

493496 - `"unrestricted"`

494

495 - `"unrestricted"`

496497

497498 - `default_inference_geo: optional "global" or "us" or null`

498499

from line 517

516517

517518 Name of the Workspace.

518519

520 maxLength: 40, minLength: 1

521

519522- `tags: optional map[string] or null`

520523

521524 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.

522525

523526### Returns

524527

525- `Workspace object { id, archived_at, compartment_id, 7 more }`

528- `Workspace object`

526529

527530 - `id: string`

528531

from line 534

531534 - `archived_at: string or null`

532535

533536 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

537

538 format: date-time

534539

535540 - `compartment_id: string`

536541

from line 550

545550

546551 RFC 3339 datetime string indicating when the Workspace was created.

547552

548 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

553 format: date-time

554

555 - `data_residency: object`

549556

550557 Data residency configuration.

551558

from line 563

556563 - `array of string`

557564

558565 - `"unrestricted"`

559

560 - `"unrestricted"`

561566

562567 - `default_inference_geo: string`

563568

from line 600

595600

596601 For Workspaces, this is always `"workspace"`.

597602

598 - `"workspace"`

603 default: workspace

599604

600605### Example

601606

602```http

607```bash

603608curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \

604609 -H 'Content-Type: application/json' \

605610 -H 'anthropic-version: 2023-06-01' \

from line 618

613618 }'

614619```

615620

616#### Response

621#### Response (200)

617622

618623```json

619624{

from line 644

639644

640645## Archive Workspace

641646

642**post** `/v1/organizations/workspaces/{workspace_id}/archive`

647**POST** `/v1/organizations/workspaces/{workspace_id}/archive`

643648

644649Archive Workspace

645650

646### Path Parameters

651### Path parameters

647652

648653- `workspace_id: string`

649654

650655### Returns

651656

652- `Workspace object { id, archived_at, compartment_id, 7 more }`

657- `Workspace object`

653658

654659 - `id: string`

655660

from line 663

658663 - `archived_at: string or null`

659664

660665 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

666

667 format: date-time

661668

662669 - `compartment_id: string`

663670

from line 679

672679

673680 RFC 3339 datetime string indicating when the Workspace was created.

674681

675 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

682 format: date-time

683

684 - `data_residency: object`

676685

677686 Data residency configuration.

678687

from line 692

683692 - `array of string`

684693

685694 - `"unrestricted"`

686

687 - `"unrestricted"`

688695

689696 - `default_inference_geo: string`

690697

from line 729

722729

723730 For Workspaces, this is always `"workspace"`.

724731

725 - `"workspace"`

732 default: workspace

726733

727734### Example

728735

729```http

736```bash

730737curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \

731738 -X POST \

732739 -H 'anthropic-version: 2023-06-01' \

733740 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

734741```

735742

736#### Response

743#### Response (200)

737744

738745```json

739746{

from line 764

757764}

758765```

759766

760# Members

761

762## Create Workspace Member

763

764**post** `/v1/organizations/workspaces/{workspace_id}/members`

767## Workspaces › Members

768

769### Create Workspace Member

770

771**POST** `/v1/organizations/workspaces/{workspace_id}/members`

765772

766773Create Workspace Member

767774

768### Path Parameters

775#### Path parameters

769776

770777- `workspace_id: string`

771778

772779 ID of the Workspace.

773780

774### Body Parameters

781#### Body parameters

775782

776783- `user_id: string`

777784

from line 796

789796

790797 - `"workspace_user"`

791798

792### Returns

793

794- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

799#### Returns

800

801- `WorkspaceMember object`

795802

796803 - `type: "workspace_member"`

797804

from line 806

799806

800807 For Workspace Members, this is always `"workspace_member"`.

801808

802 - `"workspace_member"`

809 default: workspace_member

803810

804811 - `user_id: string`

805812

from line 830

823830

824831 - `"workspace_user"`

825832

826### Example

827

828```http

833#### Example

834

835```bash

829836curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \

830837 -H 'Content-Type: application/json' \

831838 -H 'anthropic-version: 2023-06-01' \

from line 843

836843 }'

837844```

838845

839#### Response

846##### Response (200)

840847

841848```json

842849{

from line 854

847854}

848855```

849856

850## Get Workspace Member

851

852**get** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

857### Get Workspace Member

858

859**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

853860

854861Get Workspace Member

855862

856### Path Parameters

863#### Path parameters

857864

858865- `workspace_id: string`

859866

from line 870

863870

864871 ID of the User.

865872

866### Returns

867

868- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

873#### Returns

874

875- `WorkspaceMember object`

869876

870877 - `type: "workspace_member"`

871878

from line 880

873880

874881 For Workspace Members, this is always `"workspace_member"`.

875882

876 - `"workspace_member"`

883 default: workspace_member

877884

878885 - `user_id: string`

879886

from line 904

897904

898905 - `"workspace_user"`

899906

900### Example

901

902```http

907#### Example

908

909```bash

903910curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

904911 -H 'anthropic-version: 2023-06-01' \

905912 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

906913```

907914

908#### Response

915##### Response (200)

909916

910917```json

911918{

from line 923

916923}

917924```

918925

919## List Workspace Members

920

921**get** `/v1/organizations/workspaces/{workspace_id}/members`

926### List Workspace Members

927

928**GET** `/v1/organizations/workspaces/{workspace_id}/members`

922929

923930List Workspace Members

924931

925### Path Parameters

932#### Path parameters

926933

927934- `workspace_id: string`

928935

929936 ID of the Workspace.

930937

931### Query Parameters

938#### Query parameters

932939

933940- `after_id: optional string`

934941

from line 951

944951

945952 Defaults to `20`. Ranges from `1` to `1000`.

946953

947### Returns

954 default: 20, maximum: 1000, minimum: 1

955

956#### Returns

948957

949958- `data: array of WorkspaceMember`

950959

from line 963

954963

955964 For Workspace Members, this is always `"workspace_member"`.

956965

957 - `"workspace_member"`

966 default: workspace_member

958967

959968 - `user_id: string`

960969

from line 999

990999

9911000 Last ID in the `data` list. Can be used as the `after_id` for the next page.

9921001

993### Example

994

995```http

1002#### Example

1003

1004```bash

9961005curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \

9971006 -H 'anthropic-version: 2023-06-01' \

9981007 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

9991008```

10001009

1001#### Response

1010##### Response (200)

10021011

10031012```json

10041013{

from line 1025

10161025}

10171026```

10181027

1019## Update Workspace Member

1020

1021**post** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

1028### Update Workspace Member

1029

1030**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

10221031

10231032Update Workspace Member

10241033

1025### Path Parameters

1034#### Path parameters

10261035

10271036- `workspace_id: string`

10281037

from line 1041

10321041

10331042 ID of the User.

10341043

1035### Body Parameters

1044#### Body parameters

10361045

10371046- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

10381047

from line 1057

10481057

10491058 - `"workspace_user"`

10501059

1051### Returns

1052

1053- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

1060#### Returns

1061

1062- `WorkspaceMember object`

10541063

10551064 - `type: "workspace_member"`

10561065

from line 1067

10581067

10591068 For Workspace Members, this is always `"workspace_member"`.

10601069

1061 - `"workspace_member"`

1070 default: workspace_member

10621071

10631072 - `user_id: string`

10641073

from line 1091

10821091

10831092 - `"workspace_user"`

10841093

1085### Example

1086

1087```http

1094#### Example

1095

1096```bash

10881097curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

10891098 -H 'Content-Type: application/json' \

10901099 -H 'anthropic-version: 2023-06-01' \

from line 1103

10941103 }'

10951104```

10961105

1097#### Response

1106##### Response (200)

10981107

10991108```json

11001109{

from line 1114

11051114}

11061115```

11071116

1108## Delete Workspace Member

1109

1110**delete** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

1117### Delete Workspace Member

1118

1119**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

11111120

11121121Delete Workspace Member

11131122

1114### Path Parameters

1123#### Path parameters

11151124

11161125- `workspace_id: string`

11171126

from line 1130

11211130

11221131 ID of the User.

11231132

1124### Returns

1133#### Returns

11251134

11261135- `type: "workspace_member_deleted"`

11271136

from line 1138

11291138

11301139 For Workspace Members, this is always `"workspace_member_deleted"`.

11311140

1132 - `"workspace_member_deleted"`

1141 default: workspace_member_deleted

11331142

11341143- `user_id: string`

11351144

from line 1148

11391148

11401149 ID of the Workspace.

11411150

1142### Example

1143

1144```http

1151#### Example

1152

1153```bash

11451154curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

11461155 -X DELETE \

11471156 -H 'anthropic-version: 2023-06-01' \

11481157 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

11491158```

11501159

1151#### Response

1160##### Response (200)

11521161

11531162```json

11541163{

from line 1167

11581167}

11591168```

11601169

1161## Domain Types

1162

1163### Workspace Member

1164

1165- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

1166

1167 - `type: "workspace_member"`

1168

1169 Object type.

1170

1171 For Workspace Members, this is always `"workspace_member"`.

1172

1173 - `"workspace_member"`

1174

1175 - `user_id: string`

1176

1177 ID of the User.

1178

1179 - `workspace_id: string`

1180

1181 ID of the Workspace.

1182

1183 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

1184

1185 Role of the Workspace Member.

1186

1187 - `"workspace_admin"`

1188

1189 - `"workspace_billing"`

1190

1191 - `"workspace_developer"`

1192

1193 - `"workspace_restricted_developer"`

1194

1195 - `"workspace_user"`

1196

1197### Member Delete Response

1198

1199- `MemberDeleteResponse object { type, user_id, workspace_id }`

1200

1201 - `type: "workspace_member_deleted"`

1202

1203 Deleted object type.

1204

1205 For Workspace Members, this is always `"workspace_member_deleted"`.

1206

1207 - `"workspace_member_deleted"`

1208

1209 - `user_id: string`

1210

1211 ID of the User.

1212

1213 - `workspace_id: string`

1214

1215 ID of the Workspace.

1216

1217# Rate Limits

1218

1219## List Workspace Rate Limits

1220

1221**get** `/v1/organizations/workspaces/{workspace_id}/rate_limits`

1170## Workspaces › Rate Limits

1171

1172### List Workspace Rate Limits

1173

1174**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits`

12221175

12231176List rate-limit overrides configured for a workspace.

12241177

from line 1179

12261179override. Groups without overrides inherit the organization limits and

12271180are not listed; use `GET /v1/organizations/rate_limits` to see those.

12281181

1229### Path Parameters

1182#### Path parameters

12301183

12311184- `workspace_id: string`

12321185

12331186 The ID of the workspace.

12341187

1235### Query Parameters

1188#### Query parameters

12361189

12371190- `group_type: optional "batch" or "files" or "model_group" or 3 more`

12381191

from line 1207

12541207

12551208 Opaque cursor from a previous response's `next_page`.

12561209

1257### Returns

1258

1259- `data: array of object { group_type, limits, models, 3 more }`

1210#### Returns

1211

1212- `data: array of object`

12601213

12611214 Rate-limit entries for the workspace, one per group that has at least one override.

12621215

from line 1229

12761229

12771230 - `"web_search"`

12781231

1279 - `limits: array of object { org_limit, type, value }`

1232 - `limits: array of object`

12801233

12811234 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

12821235

from line 1257

13041257

13051258 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.

13061259

1307 - `"workspace_rate_limit"`

1260 default: workspace_rate_limit

13081261

13091262 - `workspace_id: string`

13101263

from line 1267

13141267

13151268 Token to provide in as `page` in the subsequent request to retrieve the next page of data.

13161269

1317### Example

1318

1319```http

1270#### Example

1271

1272```bash

13201273curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \

13211274 -H 'anthropic-version: 2023-06-01' \

13221275 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

13231276```

13241277

1325#### Response

1278##### Response (200)

13261279

13271280```json

13281281{

from line 1301

13481301}

13491302```

13501303

1351## Domain Types

1352

1353### Rate Limit List Response

1354

1355- `RateLimitListResponse object { data, next_page }`

1356

1357 - `data: array of object { group_type, limits, models, 3 more }`

1358

1359 Rate-limit entries for the workspace, one per group that has at least one override.

1360

1361 - `group_type: "batch" or "files" or "model_group" or 3 more`

1362

1363 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`.

1364

1365 - `"batch"`

1366

1367 - `"files"`

1368

1369 - `"model_group"`

1370

1371 - `"skills"`

1372

1373 - `"token_count"`

1374

1375 - `"web_search"`

1376

1377 - `limits: array of object { org_limit, type, value }`

1378

1379 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

1380

1381 - `org_limit: number or null`

1382

1383 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.

1384

1385 - `type: string`

1386

1387 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).

1388

1389 - `value: number`

1390

1391 The workspace-level override value for this limiter type.

1392

1393 - `models: array of string or null`

1394

1395 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.

1396

1397 - `rate_limit_id: string`

1398

1399 The `id` of the RateLimit group this override applies to.

1400

1401 - `type: "workspace_rate_limit"`

1402

1403 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.

1404

1405 - `"workspace_rate_limit"`

1406

1407 - `workspace_id: string`

1408

1409 ID of the Workspace this override applies to.

1410

1411 - `next_page: string or null`

1412

1413 Token to provide in as `page` in the subsequent request to retrieve the next page of data.

1414

1415# Service Accounts

1416

1417## Create Service Account Workspace Member

1418

1419**post** `/v1/organizations/workspaces/{workspace_id}/service_accounts`

1304## Workspaces › Service Accounts

1305

1306### Create Service Account Workspace Member

1307

1308**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`

14201309

14211310Add a service account to a workspace with the given `workspace_role`.

14221311

from line 1319

14301319accounts cannot be added and are rejected. Requires an OAuth bearer or

14311320Console session; Admin API keys are not accepted.

14321321

1433### Path Parameters

1322#### Path parameters

14341323

14351324- `workspace_id: string`

14361325

14371326 ID of the workspace.

14381327

1439### Header Parameters

1328#### Headers

14401329

14411330- `"anthropic-beta": optional array of string`

14421331

from line 1333

14441333

14451334 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

14461335

1447### Body Parameters

1336#### Body parameters

14481337

14491338- `service_account_id: string`

14501339

from line 1351

14621351

14631352 - `"workspace_user"`

14641353

1465### Returns

1354#### Returns

14661355

14671356- `created_by_actor_id: string or null`

14681357

from line 1367

14781367

14791368- `type: "service_account_workspace_member"`

14801369

1481 - `"service_account_workspace_member"`

1370 default: service_account_workspace_member

14821371

14831372- `workspace_id: string`

14841373

from line 1387

14981387

14991388 - `"workspace_user"`

15001389

1501### Example

1502

1503```http

1390#### Example

1391

1392```bash

15041393curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \

15051394 -H 'Content-Type: application/json' \

15061395 -H 'anthropic-version: 2023-06-01' \

from line 1400

15111400 }'

15121401```

15131402

1514#### Response

1403##### Response (200)

15151404

15161405```json

15171406{

from line 1413

15241413}

15251414```

15261415

1527## Get Service Account Workspace Member

1528

1529**get** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`

1416### Get Service Account Workspace Member

1417

1418**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`

15301419

15311420Retrieve a service account's membership in a workspace.

15321421

from line 1426

15371426membership is returned with its assigned role. An archived service

15381427account returns 404.

15391428

1540### Path Parameters

1429#### Path parameters

15411430

15421431- `workspace_id: string`

15431432

from line 1436

15471436

15481437 ID of the service account.

15491438

1550### Header Parameters

1439#### Headers

15511440

15521441- `"anthropic-beta": optional array of string`

15531442

from line 1444

15551444

15561445 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

15571446

1558### Returns

1447#### Returns

15591448

15601449- `created_by_actor_id: string or null`

15611450

from line 1460

15711460

15721461- `type: "service_account_workspace_member"`

15731462

1574 - `"service_account_workspace_member"`

1463 default: service_account_workspace_member

15751464

15761465- `workspace_id: string`

15771466

from line 1480

15911480

15921481 - `"workspace_user"`

15931482

1594### Example

1595

1596```http

1483#### Example

1484

1485```bash

15971486curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \

15981487 -H 'anthropic-version: 2023-06-01' \

15991488 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

16001489```

16011490

1602#### Response

1491##### Response (200)

16031492

16041493```json

16051494{

from line 1501

16121501}

16131502```

16141503

1615## List Service Account Workspace Members

1616

1617**get** `/v1/organizations/workspaces/{workspace_id}/service_accounts`

1504### List Service Account Workspace Members

1505

1506**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`

16181507

16191508List the service accounts that are members of a workspace.

16201509

from line 1514

16251514included in this list. Memberships of archived service accounts are

16261515omitted from the results.

16271516

1628### Path Parameters

1517#### Path parameters

16291518

16301519- `workspace_id: string`

16311520

16321521 ID of the workspace.

16331522

1634### Query Parameters

1523#### Query parameters

16351524

16361525- `limit: optional number`

16371526

16381527 Number of results per page.

16391528

1529 default: 20, maximum: 100, minimum: 1

1530

16401531- `page: optional string`

16411532

16421533 Opaque cursor from a previous response's `next_page`.

16431534

1644### Header Parameters

1535#### Headers

16451536

16461537- `"anthropic-beta": optional array of string`

16471538

from line 1540

16491540

16501541 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

16511542

1652### Returns

1653

1654- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }`

1543#### Returns

1544

1545- `data: array of object`

16551546

16561547 - `created_by_actor_id: string or null`

16571548

from line 1558

16671558

16681559 - `type: "service_account_workspace_member"`

16691560

1670 - `"service_account_workspace_member"`

1561 default: service_account_workspace_member

16711562

16721563 - `workspace_id: string`

16731564

from line 1582

16911582

16921583 Opaque cursor for the next page, or null if no more results.

16931584

1694### Example

1695

1696```http

1585#### Example

1586

1587```bash

16971588curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \

16981589 -H 'anthropic-version: 2023-06-01' \

16991590 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

17001591```

17011592

1702#### Response

1593##### Response (200)

17031594

17041595```json

17051596{

from line 1608

17171608}

17181609```

17191610

1720## Update Service Account Workspace Member

1721

1722**post** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`

1611### Update Service Account Workspace Member

1612

1613**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`

17231614

17241615Change a service account's role in a workspace.

17251616

from line 1622

17311622rejected. Requires an OAuth bearer or Console session; Admin API keys

17321623are not accepted.

17331624

1734### Path Parameters

1625#### Path parameters

17351626

17361627- `workspace_id: string`

17371628

from line 1632

17411632

17421633 ID of the service account.

17431634

1744### Header Parameters

1635#### Headers

17451636

17461637- `"anthropic-beta": optional array of string`

17471638

from line 1640

17491640

17501641 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

17511642

1752### Body Parameters

1643#### Body parameters

17531644

17541645- `workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"`

17551646

from line 1654

17631654

17641655 - `"workspace_user"`

17651656

1766### Returns

1657#### Returns

17671658

17681659- `created_by_actor_id: string or null`

17691660

from line 1670

17791670

17801671- `type: "service_account_workspace_member"`

17811672

1782 - `"service_account_workspace_member"`

1673 default: service_account_workspace_member

17831674

17841675- `workspace_id: string`

17851676

from line 1690

17991690

18001691 - `"workspace_user"`

18011692

1802### Example

1803

1804```http

1693#### Example

1694

1695```bash

18051696curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \

18061697 -H 'Content-Type: application/json' \

18071698 -H 'anthropic-version: 2023-06-01' \

from line 1702

18111702 }'

18121703```

18131704

1814#### Response

1705##### Response (200)

18151706

18161707```json

18171708{

from line 1715

18241715}

18251716```

18261717

1827## Delete Service Account Workspace Member

1828

1829**delete** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`

1718### Delete Service Account Workspace Member

1719

1720**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`

18301721

18311722Remove a service account from a workspace.

18321723

from line 1728

18371728membership. Archived workspaces return 400. Requires an OAuth bearer or

18381729Console session; Admin API keys are not accepted.

18391730

1840### Path Parameters

1731#### Path parameters

18411732

18421733- `workspace_id: string`

18431734

from line 1738

18471738

18481739 ID of the service account.

18491740

1850### Header Parameters

1741#### Headers

18511742

18521743- `"anthropic-beta": optional array of string`

18531744

from line 1746

18551746

18561747 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

18571748

1858### Returns

1749#### Returns

18591750

18601751- `service_account_id: string`

18611752

from line 1754

18631754

18641755- `type: "service_account_workspace_member_deleted"`

18651756

1866 - `"service_account_workspace_member_deleted"`

1757 default: service_account_workspace_member_deleted

18671758

18681759- `workspace_id: string`

18691760

18701761 Tagged workspace ID (`wrkspc_...`) named in the delete request.

18711762

1872### Example

1873

1874```http

1763#### Example

1764

1765```bash

18751766curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \

18761767 -X DELETE \

18771768 -H 'anthropic-version: 2023-06-01' \

18781769 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

18791770```

18801771

1881#### Response

1772##### Response (200)

18821773

18831774```json

18841775{

from line 1778

18871778 "workspace_id": "workspace_id"

18881779}

18891780```

1890

1891## Domain Types

1892

1893### Service Account Create Response

1894

1895- `ServiceAccountCreateResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`

1896

1897 - `created_by_actor_id: string or null`

1898

1899 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.

1900

1901 - `implicit: boolean or null`

1902

1903 True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.

1904

1905 - `service_account_id: string`

1906

1907 Tagged service account ID (`svac_...`).

1908

1909 - `type: "service_account_workspace_member"`

1910

1911 - `"service_account_workspace_member"`

1912

1913 - `workspace_id: string`

1914

1915 Tagged workspace ID (`wrkspc_...`).

1916

1917 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

1918

1919 Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.

1920

1921 - `"workspace_admin"`

1922

1923 - `"workspace_billing"`

1924

1925 - `"workspace_developer"`

1926

1927 - `"workspace_restricted_developer"`

1928

1929 - `"workspace_user"`

1930

1931### Service Account Retrieve Response

1932

1933- `ServiceAccountRetrieveResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`

1934

1935 - `created_by_actor_id: string or null`

1936

1937 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.

1938

1939 - `implicit: boolean or null`

1940

1941 True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.

1942

1943 - `service_account_id: string`

1944

1945 Tagged service account ID (`svac_...`).

1946

1947 - `type: "service_account_workspace_member"`

1948

1949 - `"service_account_workspace_member"`

1950

1951 - `workspace_id: string`

1952

1953 Tagged workspace ID (`wrkspc_...`).

1954

1955 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

1956

1957 Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.

1958

1959 - `"workspace_admin"`

1960

1961 - `"workspace_billing"`

1962

1963 - `"workspace_developer"`

1964

1965 - `"workspace_restricted_developer"`

1966

1967 - `"workspace_user"`

1968

1969### Service Account List Response

1970

1971- `ServiceAccountListResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`

1972

1973 - `created_by_actor_id: string or null`

1974

1975 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.

1976

1977 - `implicit: boolean or null`

1978

1979 True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.

1980

1981 - `service_account_id: string`

1982

1983 Tagged service account ID (`svac_...`).

1984

1985 - `type: "service_account_workspace_member"`

1986

1987 - `"service_account_workspace_member"`

1988

1989 - `workspace_id: string`

1990

1991 Tagged workspace ID (`wrkspc_...`).

1992

1993 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

1994

1995 Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.

1996

1997 - `"workspace_admin"`

1998

1999 - `"workspace_billing"`

2000

2001 - `"workspace_developer"`

2002

2003 - `"workspace_restricted_developer"`

2004

2005 - `"workspace_user"`

2006

2007### Service Account Update Response

2008

2009- `ServiceAccountUpdateResponse object { created_by_actor_id, implicit, service_account_id, 3 more }`

2010

2011 - `created_by_actor_id: string or null`

2012

2013 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.

2014

2015 - `implicit: boolean or null`

2016

2017 True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.

2018

2019 - `service_account_id: string`

2020

2021 Tagged service account ID (`svac_...`).

2022

2023 - `type: "service_account_workspace_member"`

2024

2025 - `"service_account_workspace_member"`

2026

2027 - `workspace_id: string`

2028

2029 Tagged workspace ID (`wrkspc_...`).

2030

2031 - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

2032

2033 Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.

2034

2035 - `"workspace_admin"`

2036

2037 - `"workspace_billing"`

2038

2039 - `"workspace_developer"`

2040

2041 - `"workspace_restricted_developer"`

2042

2043 - `"workspace_user"`

2044

2045### Service Account Delete Response

2046

2047- `ServiceAccountDeleteResponse object { service_account_id, type, workspace_id }`

2048

2049 - `service_account_id: string`

2050

2051 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.

2052

2053 - `type: "service_account_workspace_member_deleted"`

2054

2055 - `"service_account_workspace_member_deleted"`

2056

2057 - `workspace_id: string`

2058

2059 Tagged workspace ID (`wrkspc_...`) named in the delete request.

20601781

api/admin/workspaces/archive Changed · +14 / -17 lines

# Archive Workspace ## Path parameters ## Returns ## Example ### Response (200) ## Archive Workspace ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Archive Workspace

3url: https://platform.claude.com/docs/en/api/admin/workspaces/archive

4---

1# Archive Workspace

52

6## Archive Workspace

3**POST** `/v1/organizations/workspaces/{workspace_id}/archive`

74

8**post** `/v1/organizations/workspaces/{workspace_id}/archive`

9

105Archive Workspace

116

12### Path Parameters

7## Path parameters

138

149- `workspace_id: string`

1510

16### Returns

11## Returns

1712

18- `Workspace object { id, archived_at, compartment_id, 7 more }`

13- `Workspace object`

1914

2015 - `id: string`

2116

from line 20

2520

2621 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

2722

23 format: date-time

24

2825 - `compartment_id: string`

2926

3027 Identifier for this Workspace's encryption compartment. When you configure a

from line 35

3835

3936 RFC 3339 datetime string indicating when the Workspace was created.

4037

41 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

38 format: date-time

4239

40 - `data_residency: object`

41

4342 Data residency configuration.

4443

4544 - `allowed_inference_geos: array of string or "unrestricted"`

from line 49

5049

5150 - `"unrestricted"`

5251

53 - `"unrestricted"`

54

5552 - `default_inference_geo: string`

5653

5754 Default inference geo applied when requests omit the parameter.

from line 85

8885

8986 For Workspaces, this is always `"workspace"`.

9087

91 - `"workspace"`

88 default: workspace

9289

93### Example

90## Example

9491

95```http

92```bash

9693curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \

9794 -X POST \

9895 -H 'anthropic-version: 2023-06-01' \

from line 96

9996 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

10097```

10198

102#### Response

99### Response (200)

103100

104101```json

105102{

api/admin/workspaces/create Changed · +18 / -23 lines

# Create Workspace ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Create Workspace ### Header Parameters ### Body Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Create Workspace

3url: https://platform.claude.com/docs/en/api/admin/workspaces/create

4---

1# Create Workspace

52

6## Create Workspace

3**POST** `/v1/organizations/workspaces`

74

8**post** `/v1/organizations/workspaces`

9

105Create Workspace

116

12### Header Parameters

7## Headers

138

149- `"anthropic-beta": optional array of string`

1510

from line 12

1712

1813 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.

1914

20### Body Parameters

15## Body parameters

2116

2217- `name: string`

2318

2419 Name of the Workspace.

2520

26- `data_residency: optional object { allowed_inference_geos, default_inference_geo, workspace_geo } or null`

21 maxLength: 40, minLength: 1

2722

23- `data_residency: optional object or null`

24

2825 Data residency configuration for the workspace. If omitted, defaults to workspace_geo=`"us"`, allowed_inference_geos=`"unrestricted"`, and default_inference_geo=`"global"`.

2926

3027 - `allowed_inference_geos: optional array of "global" or "us" or "unrestricted" or null`

from line 36

3936

4037 - `"unrestricted"`

4138

42 - `"unrestricted"`

43

4439 - `default_inference_geo: optional "global" or "us" or null`

4540

4641 Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is `"unrestricted"`.

from line 48

5348

5449 Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

5550

56 - `"us"`

57

5851- `external_key_id: optional string or null`

5952

6053 ID of the customer-managed encryption key (CMEK) configuration to use for this

from line 62

6962

7063 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.

7164

72### Returns

65## Returns

7366

74- `Workspace object { id, archived_at, compartment_id, 7 more }`

67- `Workspace object`

7568

7669 - `id: string`

7770

from line 74

8174

8275 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

8376

77 format: date-time

78

8479 - `compartment_id: string`

8580

8681 Identifier for this Workspace's encryption compartment. When you configure a

from line 89

9489

9590 RFC 3339 datetime string indicating when the Workspace was created.

9691

97 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

92 format: date-time

9893

94 - `data_residency: object`

95

9996 Data residency configuration.

10097

10198 - `allowed_inference_geos: array of string or "unrestricted"`

from line 103

106103

107104 - `"unrestricted"`

108105

109 - `"unrestricted"`

110

111106 - `default_inference_geo: string`

112107

113108 Default inference geo applied when requests omit the parameter.

from line 139

144139

145140 For Workspaces, this is always `"workspace"`.

146141

147 - `"workspace"`

142 default: workspace

148143

149### Example

144## Example

150145

151```http

146```bash

152147curl https://api.anthropic.com/v1/organizations/workspaces \

153148 -H 'Content-Type: application/json' \

154149 -H 'anthropic-version: 2023-06-01' \

from line 158

163158 }'

164159```

165160

166#### Response

161### Response (200)

167162

168163```json

169164{

api/admin/workspaces/list Changed · +17 / -16 lines

# List Workspaces ## Query parameters ## Returns ## Example ### Response (200) ## List Workspaces ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: List Workspaces

3url: https://platform.claude.com/docs/en/api/admin/workspaces/list

4---

1# List Workspaces

52

6## List Workspaces

3**GET** `/v1/organizations/workspaces`

74

8**get** `/v1/organizations/workspaces`

9

105List Workspaces

116

12### Query Parameters

7## Query parameters

138

149- `after_id: optional string`

1510

from line 18

2318

2419 Whether to include Workspaces that have been archived in the response

2520

21 default: false

22

2623- `limit: optional number`

2724

2825 Number of items to return per page.

from line 26

2926

3027 Defaults to `20`. Ranges from `1` to `1000`.

3128

32### Returns

29 default: 20, maximum: 1000, minimum: 1

3330

31## Returns

32

3433- `data: array of Workspace`

3534

3635 - `id: string`

from line 40

4140

4241 RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.

4342

43 format: date-time

44

4445 - `compartment_id: string`

4546

4647 Identifier for this Workspace's encryption compartment. When you configure a

from line 55

5455

5556 RFC 3339 datetime string indicating when the Workspace was created.

5657

57 - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`

58 format: date-time

5859

60 - `data_residency: object`

61

5962 Data residency configuration.

6063

6164 - `allowed_inference_geos: array of string or "unrestricted"`

from line 69

6669

6770 - `"unrestricted"`

6871

69 - `"unrestricted"`

70

7172 - `default_inference_geo: string`

7273

7374 Default inference geo applied when requests omit the parameter.

from line 105

104105

105106 For Workspaces, this is always `"workspace"`.

106107

107 - `"workspace"`

108 default: workspace

108109

109110- `first_id: string or null`

110111

from line 119

118119

119120 Last ID in the `data` list. Can be used as the `after_id` for the next page.

120121

121### Example

122## Example

122123

123```http

124```bash

124125curl https://api.anthropic.com/v1/organizations/workspaces \

125126 -H 'anthropic-version: 2023-06-01' \

126127 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

127128```

128129

129#### Response

130### Response (200)

130131

131132```json

132133{

api/admin/workspaces/members Changed · +56 / -59 lines

### Path parameters ### Body parameters #### Response (200) ### Path parameters #### Response (200) ### Path parameters ### Query parameters #### Response (200) ### Path parameters ### Body parameters #### Response (200) ### Path parameters #### Response (200) ## Domain types ### Path Parameters ### Body Parameters #### Response ### Path Parameters #### Response ### Path Parameters ### Query Parameters #### Response ### Path Parameters ### Body Parameters #### Response ### Path Parameters #### Response ## Domain Types

from line 1

1---

2title: Members

3url: https://platform.claude.com/docs/en/api/admin/workspaces/members

4---

5

61# Members

72

83## Create Workspace Member

94

10**post** `/v1/organizations/workspaces/{workspace_id}/members`

5**POST** `/v1/organizations/workspaces/{workspace_id}/members`

116

127Create Workspace Member

138

14### Path Parameters

9### Path parameters

1510

1611- `workspace_id: string`

1712

1813 ID of the Workspace.

1914

20### Body Parameters

15### Body parameters

2116

2217- `user_id: string`

2318

from line 32

3732

3833### Returns

3934

40- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

35- `WorkspaceMember object`

4136

4237 - `type: "workspace_member"`

4338

from line 40

4540

4641 For Workspace Members, this is always `"workspace_member"`.

4742

48 - `"workspace_member"`

43 default: workspace_member

4944

5045 - `user_id: string`

5146

from line 66

7166

7267### Example

7368

74```http

69```bash

7570curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \

7671 -H 'Content-Type: application/json' \

7772 -H 'anthropic-version: 2023-06-01' \

from line 77

8277 }'

8378```

8479

85#### Response

80#### Response (200)

8681

8782```json

8883{

from line 90

9590

9691## Get Workspace Member

9792

98**get** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

93**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

9994

10095Get Workspace Member

10196

102### Path Parameters

97### Path parameters

10398

10499- `workspace_id: string`

105100

from line 106

111106

112107### Returns

113108

114- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

109- `WorkspaceMember object`

115110

116111 - `type: "workspace_member"`

117112

from line 114

119114

120115 For Workspace Members, this is always `"workspace_member"`.

121116

122 - `"workspace_member"`

117 default: workspace_member

123118

124119 - `user_id: string`

125120

from line 140

145140

146141### Example

147142

148```http

143```bash

149144curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

150145 -H 'anthropic-version: 2023-06-01' \

151146 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

152147```

153148

154#### Response

149#### Response (200)

155150

156151```json

157152{

from line 159

164159

165160## List Workspace Members

166161

167**get** `/v1/organizations/workspaces/{workspace_id}/members`

162**GET** `/v1/organizations/workspaces/{workspace_id}/members`

168163

169164List Workspace Members

170165

171### Path Parameters

166### Path parameters

172167

173168- `workspace_id: string`

174169

175170 ID of the Workspace.

176171

177### Query Parameters

172### Query parameters

178173

179174- `after_id: optional string`

180175

from line 185

190185

191186 Defaults to `20`. Ranges from `1` to `1000`.

192187

188 default: 20, maximum: 1000, minimum: 1

189

193190### Returns

194191

195192- `data: array of WorkspaceMember`

from line 197

200197

201198 For Workspace Members, this is always `"workspace_member"`.

202199

203 - `"workspace_member"`

200 default: workspace_member

204201

205202 - `user_id: string`

206203

from line 235

238235

239236### Example

240237

241```http

238```bash

242239curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \

243240 -H 'anthropic-version: 2023-06-01' \

244241 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

245242```

246243

247#### Response

244#### Response (200)

248245

249246```json

250247{

from line 261

264261

265262## Update Workspace Member

266263

267**post** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

264**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

268265

269266Update Workspace Member

270267

271### Path Parameters

268### Path parameters

272269

273270- `workspace_id: string`

274271

from line 275

278275

279276 ID of the User.

280277

281### Body Parameters

278### Body parameters

282279

283280- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

284281

from line 293

296293

297294### Returns

298295

299- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

296- `WorkspaceMember object`

300297

301298 - `type: "workspace_member"`

302299

from line 301

304301

305302 For Workspace Members, this is always `"workspace_member"`.

306303

307 - `"workspace_member"`

304 default: workspace_member

308305

309306 - `user_id: string`

310307

from line 327

330327

331328### Example

332329

333```http

330```bash

334331curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

335332 -H 'Content-Type: application/json' \

336333 -H 'anthropic-version: 2023-06-01' \

from line 337

340337 }'

341338```

342339

343#### Response

340#### Response (200)

344341

345342```json

346343{

from line 350

353350

354351## Delete Workspace Member

355352

356**delete** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

353**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

357354

358355Delete Workspace Member

359356

360### Path Parameters

357### Path parameters

361358

362359- `workspace_id: string`

363360

from line 372

375372

376373 For Workspace Members, this is always `"workspace_member_deleted"`.

377374

378 - `"workspace_member_deleted"`

375 default: workspace_member_deleted

379376

380377- `user_id: string`

381378

from line 384

387384

388385### Example

389386

390```http

387```bash

391388curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

392389 -X DELETE \

393390 -H 'anthropic-version: 2023-06-01' \

from line 391

394391 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

395392```

396393

397#### Response

394#### Response (200)

398395

399396```json

400397{

from line 401

404401}

405402```

406403

407## Domain Types

404## Domain types

408405

409406### Workspace Member

410407

411- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

408- `WorkspaceMember object`

412409

413410 - `type: "workspace_member"`

414411

from line 413

416413

417414 For Workspace Members, this is always `"workspace_member"`.

418415

419 - `"workspace_member"`

416 default: workspace_member

420417

421418 - `user_id: string`

422419

from line 439

442439

443440### Member Delete Response

444441

445- `MemberDeleteResponse object { type, user_id, workspace_id }`

442- `MemberDeleteResponse object`

446443

447444 - `type: "workspace_member_deleted"`

448445

from line 447

450447

451448 For Workspace Members, this is always `"workspace_member_deleted"`.

452449

453 - `"workspace_member_deleted"`

450 default: workspace_member_deleted

454451

455452 - `user_id: string`

456453

api/admin/workspaces/members/create Changed · +10 / -15 lines

# Create Workspace Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200) ## Create Workspace Member ### Path Parameters ### Body Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Create Workspace Member

3url: https://platform.claude.com/docs/en/api/admin/workspaces/members/create

4---

1# Create Workspace Member

52

6## Create Workspace Member

3**POST** `/v1/organizations/workspaces/{workspace_id}/members`

74

8**post** `/v1/organizations/workspaces/{workspace_id}/members`

9

105Create Workspace Member

116

12### Path Parameters

7## Path parameters

138

149- `workspace_id: string`

1510

1611 ID of the Workspace.

1712

18### Body Parameters

13## Body parameters

1914

2015- `user_id: string`

2116

from line 28

3328

3429 - `"workspace_user"`

3530

36### Returns

31## Returns

3732

38- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

33- `WorkspaceMember object`

3934

4035 - `type: "workspace_member"`

4136

from line 38

4338

4439 For Workspace Members, this is always `"workspace_member"`.

4540

46 - `"workspace_member"`

41 default: workspace_member

4742

4843 - `user_id: string`

4944

from line 62

6762

6863 - `"workspace_user"`

6964

70### Example

65## Example

7166

72```http

67```bash

7368curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \

7469 -H 'Content-Type: application/json' \

7570 -H 'anthropic-version: 2023-06-01' \

from line 75

8075 }'

8176```

8277

83#### Response

78### Response (200)

8479

8580```json

8681{

api/admin/workspaces/members/delete Changed · +8 / -13 lines

# Delete Workspace Member ## Path parameters ## Returns ## Example ### Response (200) ## Delete Workspace Member ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Delete Workspace Member

3url: https://platform.claude.com/docs/en/api/admin/workspaces/members/delete

4---

1# Delete Workspace Member

52

6## Delete Workspace Member

3**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

74

8**delete** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

9

105Delete Workspace Member

116

12### Path Parameters

7## Path parameters

138

149- `workspace_id: string`

1510

from line 14

1914

2015 ID of the User.

2116

22### Returns

17## Returns

2318

2419- `type: "workspace_member_deleted"`

2520

from line 22

2722

2823 For Workspace Members, this is always `"workspace_member_deleted"`.

2924

30 - `"workspace_member_deleted"`

25 default: workspace_member_deleted

3126

3227- `user_id: string`

3328

from line 32

3732

3833 ID of the Workspace.

3934

40### Example

35## Example

4136

42```http

37```bash

4338curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

4439 -X DELETE \

4540 -H 'anthropic-version: 2023-06-01' \

from line 41

4641 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

4742```

4843

49#### Response

44### Response (200)

5045

5146```json

5247{

api/admin/workspaces/members/list Changed · +11 / -14 lines

# List Workspace Members ## Path parameters ## Query parameters ## Returns ## Example ### Response (200) ## List Workspace Members ### Path Parameters ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: List Workspace Members

3url: https://platform.claude.com/docs/en/api/admin/workspaces/members/list

4---

1# List Workspace Members

52

6## List Workspace Members

3**GET** `/v1/organizations/workspaces/{workspace_id}/members`

74

8**get** `/v1/organizations/workspaces/{workspace_id}/members`

9

105List Workspace Members

116

12### Path Parameters

7## Path parameters

138

149- `workspace_id: string`

1510

1611 ID of the Workspace.

1712

18### Query Parameters

13## Query parameters

1914

2015- `after_id: optional string`

2116

from line 26

3126

3227 Defaults to `20`. Ranges from `1` to `1000`.

3328

34### Returns

29 default: 20, maximum: 1000, minimum: 1

3530

31## Returns

32

3633- `data: array of WorkspaceMember`

3734

3835 - `type: "workspace_member"`

from line 38

4138

4239 For Workspace Members, this is always `"workspace_member"`.

4340

44 - `"workspace_member"`

41 default: workspace_member

4542

4643 - `user_id: string`

4744

from line 74

7774

7875 Last ID in the `data` list. Can be used as the `after_id` for the next page.

7976

80### Example

77## Example

8178

82```http

79```bash

8380curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \

8481 -H 'anthropic-version: 2023-06-01' \

8582 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

8683```

8784

88#### Response

85### Response (200)

8986

9087```json

9188{

api/admin/workspaces/members/retrieve Changed · +9 / -14 lines

# Get Workspace Member ## Path parameters ## Returns ## Example ### Response (200) ## Get Workspace Member ### Path Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Get Workspace Member

3url: https://platform.claude.com/docs/en/api/admin/workspaces/members/retrieve

4---

1# Get Workspace Member

52

6## Get Workspace Member

3**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

74

8**get** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

9

105Get Workspace Member

116

12### Path Parameters

7## Path parameters

138

149- `workspace_id: string`

1510

from line 14

1914

2015 ID of the User.

2116

22### Returns

17## Returns

2318

24- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

19- `WorkspaceMember object`

2520

2621 - `type: "workspace_member"`

2722

from line 24

2924

3025 For Workspace Members, this is always `"workspace_member"`.

3126

32 - `"workspace_member"`

27 default: workspace_member

3328

3429 - `user_id: string`

3530

from line 48

5348

5449 - `"workspace_user"`

5550

56### Example

51## Example

5752

58```http

53```bash

5954curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

6055 -H 'anthropic-version: 2023-06-01' \

6156 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

6257```

6358

64#### Response

59### Response (200)

6560

6661```json

6762{

api/admin/workspaces/members/update Changed · +10 / -15 lines

# Update Workspace Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200) ## Update Workspace Member ### Path Parameters ### Body Parameters ### Returns ### Example #### Response

from line 1

1---

2title: Update Workspace Member

3url: https://platform.claude.com/docs/en/api/admin/workspaces/members/update

4---

1# Update Workspace Member

52

6## Update Workspace Member

3**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

74

8**post** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

9

105Update Workspace Member

116

12### Path Parameters

7## Path parameters

138

149- `workspace_id: string`

1510

from line 14

1914

2015 ID of the User.

2116

22### Body Parameters

17## Body parameters

2318

2419- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`

2520

from line 30

3530

3631 - `"workspace_user"`

3732

38### Returns

33## Returns

3934

40- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`

35- `WorkspaceMember object`

4136

4237 - `type: "workspace_member"`

4338

from line 40

4540

4641 For Workspace Members, this is always `"workspace_member"`.

4742

48 - `"workspace_member"`

43 default: workspace_member

4944

5045 - `user_id: string`

5146

from line 64

6964

7065 - `"workspace_user"`

7166

72### Example

67## Example

7368

74```http

69```bash

7570curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \

7671 -H 'Content-Type: application/json' \

7772 -H 'anthropic-version: 2023-06-01' \

from line 76

8176 }'

8277```

8378

84#### Response

79### Response (200)

8580

8681```json

8782{

api/admin/workspaces/rate_limits Changed · +13 / -18 lines

### Path parameters ### Query parameters #### Response (200) ## Domain types ### Path Parameters ### Query Parameters #### Response ## Domain Types

from line 1

1---

2title: Rate Limits

3url: https://platform.claude.com/docs/en/api/admin/workspaces/rate_limits

4---

5

61# Rate Limits

72

83## List Workspace Rate Limits

94

10**get** `/v1/organizations/workspaces/{workspace_id}/rate_limits`

5**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits`

116

127List rate-limit overrides configured for a workspace.

138

from line 10

1510override. Groups without overrides inherit the organization limits and

1611are not listed; use `GET /v1/organizations/rate_limits` to see those.

1712

18### Path Parameters

13### Path parameters

1914

2015- `workspace_id: string`

2116

2217 The ID of the workspace.

2318

24### Query Parameters

19### Query parameters

2520

2621- `group_type: optional "batch" or "files" or "model_group" or 3 more`

2722

from line 40

4540

4641### Returns

4742

48- `data: array of object { group_type, limits, models, 3 more }`

43- `data: array of object`

4944

5045 Rate-limit entries for the workspace, one per group that has at least one override.

5146

from line 60

6560

6661 - `"web_search"`

6762

68 - `limits: array of object { org_limit, type, value }`

63 - `limits: array of object`

6964

7065 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

7166

from line 88

9388

9489 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.

9590

96 - `"workspace_rate_limit"`

91 default: workspace_rate_limit

9792

9893 - `workspace_id: string`

9994

from line 100

105100

106101### Example

107102

108```http

103```bash

109104curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \

110105 -H 'anthropic-version: 2023-06-01' \

111106 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

112107```

113108

114#### Response

109#### Response (200)

115110

116111```json

117112{

from line 132

137132}

138133```

139134

140## Domain Types

135## Domain types

141136

142137### Rate Limit List Response

143138

144- `RateLimitListResponse object { data, next_page }`

139- `RateLimitListResponse object`

145140

146 - `data: array of object { group_type, limits, models, 3 more }`

141 - `data: array of object`

147142

148143 Rate-limit entries for the workspace, one per group that has at least one override.

149144

from line 158

163158

164159 - `"web_search"`

165160

166 - `limits: array of object { org_limit, type, value }`

161 - `limits: array of object`

167162

168163 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

169164

from line 186

191186

192187 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.

193188

194 - `"workspace_rate_limit"`

189 default: workspace_rate_limit

195190

196191 - `workspace_id: string`

197192

api/admin/workspaces/rate_limits/list Changed · +11 / -16 lines

# List Workspace Rate Limits ## Path parameters ## Query parameters ## Returns ## Example ### Response (200) ## List Workspace Rate Limits ### Path Parameters ### Query Parameters ### Returns ### Example #### Response

from line 1

1---

2title: List Workspace Rate Limits

3url: https://platform.claude.com/docs/en/api/admin/workspaces/rate_limits/list

4---

1# List Workspace Rate Limits

52

6## List Workspace Rate Limits

3**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits`

74

8**get** `/v1/organizations/workspaces/{workspace_id}/rate_limits`

9

105List rate-limit overrides configured for a workspace.

116

127Returns only the groups and limiter types that have a workspace-level

from line 8

138override. Groups without overrides inherit the organization limits and

149are not listed; use `GET /v1/organizations/rate_limits` to see those.

1510

16### Path Parameters

11## Path parameters

1712

1813- `workspace_id: string`

1914

2015 The ID of the workspace.

2116

22### Query Parameters

17## Query parameters

2318

2419- `group_type: optional "batch" or "files" or "model_group" or 3 more`

2520

from line 36

4136

4237 Opaque cursor from a previous response's `next_page`.

4338

44### Returns

39## Returns

4540

46- `data: array of object { group_type, limits, models, 3 more }`

41- `data: array of object`

4742

4843 Rate-limit entries for the workspace, one per group that has at least one override.

4944

from line 58

6358

6459 - `"web_search"`

6560

66 - `limits: array of object { org_limit, type, value }`

61 - `limits: array of object`

6762

6863 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

6964

from line 86

9186

9287 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.

9388

94 - `"workspace_rate_limit"`

89 default: workspace_rate_limit

9590

9691 - `workspace_id: string`

9792

from line 96

10196

10297 Token to provide in as `page` in the subsequent request to retrieve the next page of data.

10398

104### Example

99## Example

105100

106```http

101```bash

107102curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \

108103 -H 'anthropic-version: 2023-06-01' \

109104 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

110105```

111106

112#### Response

107### Response (200)

113108

114109```json

115110{

One read of Claude Developer Platformapi-20260825T033708Z

What this read moved

api/admin/spend_limits/increase_requests/deny Changed · +50 / -45 lines

api/admin/spend_limits/increase_requests/list Changed · +48 / -41 lines

api/admin/spend_limits/increase_requests/retrieve Changed · +49 / -44 lines

api/admin/spend_limits/list_effective Changed · +30 / -27 lines

api/admin/spend_limits/retrieve Changed · +24 / -25 lines

api/admin/usage_report Changed · +68 / -59 lines

api/admin/usage_report/retrieve_claude_code Changed · +28 / -31 lines

api/admin/usage_report/retrieve_messages Changed · +27 / -22 lines

api/admin/users Changed · +40 / -33 lines

api/admin/users/delete Changed · +8 / -13 lines

api/admin/users/list Changed · +14 / -13 lines

api/admin/users/retrieve Changed · +11 / -14 lines

api/admin/users/update Changed · +12 / -15 lines

api/admin/workspaces Changed · +213 / -492 lines

api/admin/workspaces/archive Changed · +14 / -17 lines

api/admin/workspaces/create Changed · +18 / -23 lines

api/admin/workspaces/list Changed · +17 / -16 lines

api/admin/workspaces/members Changed · +56 / -59 lines

api/admin/workspaces/members/create Changed · +10 / -15 lines

api/admin/workspaces/members/delete Changed · +8 / -13 lines

api/admin/workspaces/members/list Changed · +11 / -14 lines

api/admin/workspaces/members/retrieve Changed · +9 / -14 lines

api/admin/workspaces/members/update Changed · +10 / -15 lines

api/admin/workspaces/rate_limits Changed · +13 / -18 lines

api/admin/workspaces/rate_limits/list Changed · +11 / -16 lines