Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsClaude Developer Platform
One capture · api

One read of Claude Developer Platformapi-20260825T033708Z

377 pages moved out of 612 read.

Pages moved 377 significant first
Pages read 612 in this capture
Captured 03:37 UTC
Corpus hash 7d98cae5bb87 corpus-hash

What this read moved

326-350 of 377, page 14 of 16

This capture is too large to show at once. Changes 326-350 of 377 are below, significant first; the rest are on the following screens.

api/compliance/code/artifacts Changed · +47 / -30 lines

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

from line 1
1---
2title: Artifacts
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts
4---
5 
61# Artifacts
72 
83## List Code Artifacts
94 
10**get** `/v1/compliance/apps/code/artifacts`
5**GET** `/v1/compliance/apps/code/artifacts`
116 
127List Claude Code Artifacts owned by organizations under the parent
138organization.
from line 17
2217Artifacts owned by a since-deleted child organization are not
2318returned.
2419 
25### Query Parameters
20### Query parameters
2621 
2722- `limit: optional number`
2823 
2924 Maximum results (default: 20, max: 100)
3025 
26 default: 20, maximum: 100, minimum: 1
27 
3128- `organization_ids: optional array of string`
3229 
3330 Filter by organization IDs (accepts `org_...` or organization UUID, up to 500). Enumerate IDs via `GET /v1/compliance/organizations`.
3431 
32 maxItems: 500
33 
3534- `page: optional string`
3635 
3736 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
3837 
39- `updated_at: optional object { gt, gte, lt, lte }`
38- `updated_at: optional object`
4039 
4140 - `gt: optional string`
4241 
4342 Return only Artifacts updated after this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
4443 
44 format: date-time
45 
4546 - `gte: optional string`
4647 
4748 Return only Artifacts updated at or after this time (RFC 3339 format). Time filters match an eventually-consistent index and Artifacts published before this field was recorded never match — omit the time filter for compliance-complete enumeration. For incremental export, apply a generous overlap margin between windows and dedupe by `id`: adjacent tiling silently misses items whose index update lagged their publish.
4849 
50 format: date-time
51 
4952 - `lt: optional string`
5053 
5154 Return only Artifacts updated before this time (RFC 3339 format). Multiple time operators are AND-ed to the tightest bound. See `updated_at.gte` for the completeness caveat.
5255 
56 format: date-time
57 
5358 - `lte: optional string`
5459 
5560 Return only Artifacts updated at or before this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
5661 
62 format: date-time
63 
5764- `user_ids: optional array of string`
5865 
5966 Filter by owner user IDs (up to 200). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
6067 
61### Header Parameters
68 maxItems: 200
6269 
70### Headers
71 
6372- `"x-api-key": optional string`
6473 
6574### Returns
6675 
67- `data: array of object { id, organization_uuid, owner_user_id, 5 more }`
76- `data: array of object`
6877 
6978 Page of Artifacts
7079 
from line 109
100109 
101110 Artifact last update timestamp, or null for Artifacts published before this field was recorded
102111 
103 - `user: object { id, email_address } or null`
112 format: date-time
104113 
114 - `user: object or null`
115 
105116 The user who owns a Code Artifact.
106117 
107118 Fields that reference this type are null when the Artifact was
from line 128
117128 
118129 User's email address
119130 
120 - `versions: array of object { id, created_at, name }`
131 - `versions: array of object`
121132 
122133 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content.
123134 
from line 140
129140 
130141 When this version was published
131142 
143 format: date-time
144 
132145 - `name: string`
133146 
134147 Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained.
from line 156
143156 
144157### Example
145158 
146```http
159```bash
147160curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
148161 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
149162```
150163 
151#### Response
164#### Response (200)
152165 
153166```json
154167{
from line 193
180193 
181194## Download Code Artifact Version Content
182195 
183**get** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
196**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
184197 
185198Streams the content of one version of a Claude Code Artifact as the
186199response body.
from line 208
195208only truncation signal for encoded content. `Content-MD5` is emitted
196209only for identity-stored content; validate against it when present.
197210 
198### Path Parameters
211### Path parameters
199212 
200213- `artifact_id: string`
201214 
from line 218
205218 
206219 Opaque version identifier from the Artifact's `versions` list
207220 
208### Header Parameters
221### Headers
209222 
210223- `"x-api-key": optional string`
211224 
212225### Example
213226 
214```http
227```bash
215228curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
216229 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
217230```
from line 231
218231 
219232## Delete Code Artifact
220233 
221**delete** `/v1/compliance/apps/code/artifacts/{artifact_id}`
234**DELETE** `/v1/compliance/apps/code/artifacts/{artifact_id}`
222235 
223236Permanently deletes a Code Artifact and all its versions. This is a
224237destructive operation that cannot be undone. A 200 response means the
from line 242
229242organization. Returns 404 on a repeated delete of an already-deleted
230243Artifact.
231244 
232### Path Parameters
245### Path parameters
233246 
234247- `artifact_id: string`
235248 
236249 The Artifact ID (tagged ID, e.g., cart_abc123)
237250 
238### Header Parameters
251### Headers
239252 
240253- `"x-api-key": optional string`
241254 
from line 262
249262 
250263 Constant string confirming deletion
251264 
252 - `"code_artifact_deleted"`
265 default: code_artifact_deleted
253266 
254267### Example
255268 
256```http
269```bash
257270curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
258271 -X DELETE \
259272 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
260273```
261274 
262#### Response
275#### Response (200)
263276 
264277```json
265278{
from line 281
268281}
269282```
270283 
271## Domain Types
284## Domain types
272285 
273286### Artifact List Response
274287 
275- `ArtifactListResponse object { id, organization_uuid, owner_user_id, 5 more }`
288- `ArtifactListResponse object`
276289 
277290 A hosted site published via Claude Code.
278291 
from line 321
308321 
309322 Artifact last update timestamp, or null for Artifacts published before this field was recorded
310323 
311 - `user: object { id, email_address } or null`
324 format: date-time
312325 
326 - `user: object or null`
327 
313328 The user who owns a Code Artifact.
314329 
315330 Fields that reference this type are null when the Artifact was
from line 340
325340 
326341 User's email address
327342 
328 - `versions: array of object { id, created_at, name }`
343 - `versions: array of object`
329344 
330345 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content.
331346 
from line 352
337352 
338353 When this version was published
339354 
355 format: date-time
356 
340357 - `name: string`
341358 
342359 Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained.
from line 360
343360 
344361### Artifact Delete Response
345362 
346- `ArtifactDeleteResponse object { id, type }`
363- `ArtifactDeleteResponse object`
347364 
348365 Response for deleting a Code Artifact.
349366 
from line 372
355372 
356373 Constant string confirming deletion
357374 
358 - `"code_artifact_deleted"`
375 default: code_artifact_deleted
359376 

api/compliance/code/artifacts/delete Changed · +9 / -14 lines

# Delete Code Artifact ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Delete Code Artifact ### Path Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: Delete Code Artifact
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts/delete
4---
1# Delete Code Artifact
52 
6## Delete Code Artifact
3**DELETE** `/v1/compliance/apps/code/artifacts/{artifact_id}`
74 
8**delete** `/v1/compliance/apps/code/artifacts/{artifact_id}`
9 
105Permanently deletes a Code Artifact and all its versions. This is a
116destructive operation that cannot be undone. A 200 response means the
127deletion is initiated and the Artifact is claimed; content removal
from line 11
1611organization. Returns 404 on a repeated delete of an already-deleted
1712Artifact.
1813 
19### Path Parameters
14## Path parameters
2015 
2116- `artifact_id: string`
2217 
2318 The Artifact ID (tagged ID, e.g., cart_abc123)
2419 
25### Header Parameters
20## Headers
2621 
2722- `"x-api-key": optional string`
2823 
29### Returns
24## Returns
3025 
3126- `id: string`
3227 
from line 31
3631 
3732 Constant string confirming deletion
3833 
39 - `"code_artifact_deleted"`
34 default: code_artifact_deleted
4035 
41### Example
36## Example
4237 
43```http
38```bash
4439curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
4540 -X DELETE \
4641 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
4742```
4843 
49#### Response
44### Response (200)
5045 
5146```json
5247{

api/compliance/code/artifacts/list Changed · +30 / -17 lines

# List Code Artifacts ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Code Artifacts ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List Code Artifacts
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts/list
4---
1# List Code Artifacts
52 
6## List Code Artifacts
3**GET** `/v1/compliance/apps/code/artifacts`
74 
8**get** `/v1/compliance/apps/code/artifacts`
9 
105List Claude Code Artifacts owned by organizations under the parent
116organization.
127 
from line 15
2015Artifacts owned by a since-deleted child organization are not
2116returned.
2217 
23### Query Parameters
18## Query parameters
2419 
2520- `limit: optional number`
2621 
2722 Maximum results (default: 20, max: 100)
2823 
24 default: 20, maximum: 100, minimum: 1
25 
2926- `organization_ids: optional array of string`
3027 
3128 Filter by organization IDs (accepts `org_...` or organization UUID, up to 500). Enumerate IDs via `GET /v1/compliance/organizations`.
3229 
30 maxItems: 500
31 
3332- `page: optional string`
3433 
3534 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
3635 
37- `updated_at: optional object { gt, gte, lt, lte }`
36- `updated_at: optional object`
3837 
3938 - `gt: optional string`
4039 
4140 Return only Artifacts updated after this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
4241 
42 format: date-time
43 
4344 - `gte: optional string`
4445 
4546 Return only Artifacts updated at or after this time (RFC 3339 format). Time filters match an eventually-consistent index and Artifacts published before this field was recorded never match — omit the time filter for compliance-complete enumeration. For incremental export, apply a generous overlap margin between windows and dedupe by `id`: adjacent tiling silently misses items whose index update lagged their publish.
4647 
48 format: date-time
49 
4750 - `lt: optional string`
4851 
4952 Return only Artifacts updated before this time (RFC 3339 format). Multiple time operators are AND-ed to the tightest bound. See `updated_at.gte` for the completeness caveat.
5053 
54 format: date-time
55 
5156 - `lte: optional string`
5257 
5358 Return only Artifacts updated at or before this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
5459 
60 format: date-time
61 
5562- `user_ids: optional array of string`
5663 
5764 Filter by owner user IDs (up to 200). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
5865 
59### Header Parameters
66 maxItems: 200
6067 
68## Headers
69 
6170- `"x-api-key": optional string`
6271 
63### Returns
72## Returns
6473 
65- `data: array of object { id, organization_uuid, owner_user_id, 5 more }`
74- `data: array of object`
6675 
6776 Page of Artifacts
6877 
from line 107
98107 
99108 Artifact last update timestamp, or null for Artifacts published before this field was recorded
100109 
101 - `user: object { id, email_address } or null`
110 format: date-time
102111 
112 - `user: object or null`
113 
103114 The user who owns a Code Artifact.
104115 
105116 Fields that reference this type are null when the Artifact was
from line 126
115126 
116127 User's email address
117128 
118 - `versions: array of object { id, created_at, name }`
129 - `versions: array of object`
119130 
120131 Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content.
121132 
from line 138
127138 
128139 When this version was published
129140 
141 format: date-time
142 
130143 - `name: string`
131144 
132145 Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained.
from line 152
139152 
140153 Token to retrieve the next page. Use this as the 'page' parameter in your next request
141154 
142### Example
155## Example
143156 
144```http
157```bash
145158curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
146159 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
147160```
148161 
149#### Response
162### Response (200)
150163 
151164```json
152165{

api/compliance/code/artifacts/retrieve_version Changed · +6 / -11 lines

# Download Code Artifact Version Content ## Path parameters ## Headers ## Example ## Download Code Artifact Version Content ### Path Parameters ### Header Parameters ### Example

from line 1
1---
2title: Download Code Artifact Version Content
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts/retrieve_version
4---
1# Download Code Artifact Version Content
52 
6## Download Code Artifact Version Content
3**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
74 
8**get** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
9 
105Streams the content of one version of a Claude Code Artifact as the
116response body.
127 
from line 15
2015only truncation signal for encoded content. `Content-MD5` is emitted
2116only for identity-stored content; validate against it when present.
2217 
23### Path Parameters
18## Path parameters
2419 
2520- `artifact_id: string`
2621 
from line 25
3025 
3126 Opaque version identifier from the Artifact's `versions` list
3227 
33### Header Parameters
28## Headers
3429 
3530- `"x-api-key": optional string`
3631 
37### Example
32## Example
3833 
39```http
34```bash
4035curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
4136 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
4237```

api/compliance/groups Changed · +35 / -58 lines

### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## Groups › Members ### List Compliance Group Members #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Members ## List Compliance Group Members ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### Member List Response

from line 1
1---
2title: Groups
3url: https://platform.claude.com/docs/en/api/compliance/groups
4---
5 
61# Groups
72 
83## List Compliance Groups
94 
10**get** `/v1/compliance/groups`
5**GET** `/v1/compliance/groups`
116 
127List Compliance Groups
138 
14### Query Parameters
9### Query parameters
1510 
1611- `limit: optional number`
1712 
1813 Maximum results (default: 500, max: 1000)
1914 
15 default: 500, maximum: 1000, minimum: 1
16 
2017- `name_prefix: optional string`
2118 
2219 Filter groups by name prefix
2320 
21 default: ""
22 
2423- `page: optional string`
2524 
2625 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2726 
28### Header Parameters
27### Headers
2928 
3029- `"x-api-key": optional string`
3130 
3231### Returns
3332 
34- `data: array of object { id, created_at, description, 4 more }`
33- `data: array of object`
3534 
3635 List of groups
3736 
from line 72
7372 
7473### Example
7574 
76```http
75```bash
7776curl https://api.anthropic.com/v1/compliance/groups \
7877 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
7978```
8079 
81#### Response
80#### Response (200)
8281 
8382```json
8483{
from line 102
103102 
104103## Get Compliance Group
105104 
106**get** `/v1/compliance/groups/{group_id}`
105**GET** `/v1/compliance/groups/{group_id}`
107106 
108107Get Compliance Group
109108 
110### Path Parameters
109### Path parameters
111110 
112111- `group_id: string`
113112 
114113 The group ID (tagged ID, e.g., rbac_group_abc123)
115114 
116### Header Parameters
115### Headers
117116 
118117- `"x-api-key": optional string`
119118 
from line 148
149148 
150149### Example
151150 
152```http
151```bash
153152curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID \
154153 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
155154```
156155 
157#### Response
156#### Response (200)
158157 
159158```json
160159{
from line 170
171170}
172171```
173172 
174## Domain Types
173## Domain types
175174 
176175### Group List Response
177176 
178- `GroupListResponse object { id, created_at, description, 4 more }`
177- `GroupListResponse object`
179178 
180179 Group information for compliance responses.
181180 
from line 208
209208 
210209### Group Retrieve Response
211210 
212- `GroupRetrieveResponse object { id, created_at, description, 4 more }`
211- `GroupRetrieveResponse object`
213212 
214213 Group information for compliance responses.
215214 
from line 240
241240 
242241 Group last-updated timestamp (ISO 8601)
243242 
244# Members
243## Groups › Members
245244 
246## List Compliance Group Members
245### List Compliance Group Members
247246 
248**get** `/v1/compliance/groups/{group_id}/members`
247**GET** `/v1/compliance/groups/{group_id}/members`
249248 
250249List Compliance Group Members
251250 
252### Path Parameters
251#### Path parameters
253252 
254253- `group_id: string`
255254 
256255 The group ID (tagged ID, e.g., rbac_group_abc123)
257256 
258### Query Parameters
257#### Query parameters
259258 
260259- `limit: optional number`
261260 
262261 Maximum results (default: 500, max: 1000)
263262 
263 default: 500, maximum: 1000, minimum: 1
264 
264265- `page: optional string`
265266 
266267 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
267268 
268### Header Parameters
269#### Headers
269270 
270271- `"x-api-key": optional string`
271272 
272### Returns
273#### Returns
273274 
274- `data: array of object { created_at, email, updated_at, user_id }`
275- `data: array of object`
275276 
276277 List of group members
277278 
from line 300
299300 
300301 Token to retrieve the next page. Use this as the 'page' parameter in your next request
301302 
302### Example
303#### Example
303304 
304```http
305```bash
305306curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \
306307 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
307308```
308309 
309#### Response
310##### Response (200)
310311 
311312```json
312313{
from line 323
322323 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
323324}
324325```
325 
326## Domain Types
327 
328### Member List Response
329 
330- `MemberListResponse object { created_at, email, updated_at, user_id }`
331 
332 Group member for compliance responses.
333 
334 - `created_at: string or null`
335 
336 Membership creation timestamp (ISO 8601)
337 
338 - `email: string`
339 
340 Member email address
341 
342 - `updated_at: string or null`
343 
344 Membership last-updated timestamp (ISO 8601)
345 
346 - `user_id: string`
347 
348 Member user identifier (tagged ID)
349326 

api/compliance/groups/list Changed · +13 / -14 lines

# List Compliance Groups ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Compliance Groups ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List Compliance Groups
3url: https://platform.claude.com/docs/en/api/compliance/groups/list
4---
1# List Compliance Groups
52 
6## List Compliance Groups
3**GET** `/v1/compliance/groups`
74 
8**get** `/v1/compliance/groups`
9 
105List Compliance Groups
116 
12### Query Parameters
7## Query parameters
138 
149- `limit: optional number`
1510 
1611 Maximum results (default: 500, max: 1000)
1712 
13 default: 500, maximum: 1000, minimum: 1
14 
1815- `name_prefix: optional string`
1916 
2017 Filter groups by name prefix
2118 
19 default: ""
20 
2221- `page: optional string`
2322 
2423 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2524 
26### Header Parameters
25## Headers
2726 
2827- `"x-api-key": optional string`
2928 
30### Returns
29## Returns
3130 
32- `data: array of object { id, created_at, description, 4 more }`
31- `data: array of object`
3332 
3433 List of groups
3534 
from line 68
6968 
7069 Token to retrieve the next page. Use this as the 'page' parameter in your next request
7170 
72### Example
71## Example
7372 
74```http
73```bash
7574curl https://api.anthropic.com/v1/compliance/groups \
7675 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
7776```
7877 
79#### Response
78### Response (200)
8079 
8180```json
8281{

api/compliance/groups/members Changed · +11 / -14 lines

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

from line 1
1---
2title: Members
3url: https://platform.claude.com/docs/en/api/compliance/groups/members
4---
5 
61# Members
72 
83## List Compliance Group Members
94 
10**get** `/v1/compliance/groups/{group_id}/members`
5**GET** `/v1/compliance/groups/{group_id}/members`
116 
127List Compliance Group Members
138 
14### Path Parameters
9### Path parameters
1510 
1611- `group_id: string`
1712 
1813 The group ID (tagged ID, e.g., rbac_group_abc123)
1914 
20### Query Parameters
15### Query parameters
2116 
2217- `limit: optional number`
2318 
2419 Maximum results (default: 500, max: 1000)
2520 
21 default: 500, maximum: 1000, minimum: 1
22 
2623- `page: optional string`
2724 
2825 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2926 
30### Header Parameters
27### Headers
3128 
3229- `"x-api-key": optional string`
3330 
3431### Returns
3532 
36- `data: array of object { created_at, email, updated_at, user_id }`
33- `data: array of object`
3734 
3835 List of group members
3936 
from line 60
6360 
6461### Example
6562 
66```http
63```bash
6764curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \
6865 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6966```
7067 
71#### Response
68#### Response (200)
7269 
7370```json
7471{
from line 82
8582}
8683```
8784 
88## Domain Types
85## Domain types
8986 
9087### Member List Response
9188 
92- `MemberListResponse object { created_at, email, updated_at, user_id }`
89- `MemberListResponse object`
9390 
9491 Group member for compliance responses.
9592 

api/compliance/groups/members/list Changed · +12 / -15 lines

# List Compliance Group Members ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Compliance Group Members ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List Compliance Group Members
3url: https://platform.claude.com/docs/en/api/compliance/groups/members/list
4---
1# List Compliance Group Members
52 
6## List Compliance Group Members
3**GET** `/v1/compliance/groups/{group_id}/members`
74 
8**get** `/v1/compliance/groups/{group_id}/members`
9 
105List Compliance Group Members
116 
12### Path Parameters
7## Path parameters
138 
149- `group_id: string`
1510 
1611 The group ID (tagged ID, e.g., rbac_group_abc123)
1712 
18### Query Parameters
13## Query parameters
1914 
2015- `limit: optional number`
2116 
2217 Maximum results (default: 500, max: 1000)
2318 
19 default: 500, maximum: 1000, minimum: 1
20 
2421- `page: optional string`
2522 
2623 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2724 
28### Header Parameters
25## Headers
2926 
3027- `"x-api-key": optional string`
3128 
32### Returns
29## Returns
3330 
34- `data: array of object { created_at, email, updated_at, user_id }`
31- `data: array of object`
3532 
3633 List of group members
3734 
from line 56
5956 
6057 Token to retrieve the next page. Use this as the 'page' parameter in your next request
6158 
62### Example
59## Example
6360 
64```http
61```bash
6562curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \
6663 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6764```
6865 
69#### Response
66### Response (200)
7067 
7168```json
7269{

api/compliance/groups/retrieve Changed · +8 / -13 lines

# Get Compliance Group ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get Compliance Group ### Path Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: Get Compliance Group
3url: https://platform.claude.com/docs/en/api/compliance/groups/retrieve
4---
1# Get Compliance Group
52 
6## Get Compliance Group
3**GET** `/v1/compliance/groups/{group_id}`
74 
8**get** `/v1/compliance/groups/{group_id}`
9 
105Get Compliance Group
116 
12### Path Parameters
7## Path parameters
138 
149- `group_id: string`
1510 
1611 The group ID (tagged ID, e.g., rbac_group_abc123)
1712 
18### Header Parameters
13## Headers
1914 
2015- `"x-api-key": optional string`
2116 
22### Returns
17## Returns
2318 
2419- `id: string`
2520 
from line 44
4944 
5045 Group last-updated timestamp (ISO 8601)
5146 
52### Example
47## Example
5348 
54```http
49```bash
5550curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID \
5651 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
5752```
5853 
59#### Response
54### Response (200)
6055 
6156```json
6257{

api/compliance/organizations Changed · +144 / -545 lines

### Query parameters ### Headers #### Response (200) ## Domain types ## Organizations › Users ### List organization users #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ## Organizations › Roles ### List Compliance Roles #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Get Compliance Role #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ## Organizations › Roles › Permissions ### List Compliance Role Permissions #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ## Organizations › Settings ### Get effective organization settings #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### Query Parameters ### Header Parameters #### Response ## Domain Types # Users ## List organization users ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### User List Response # Roles ## List Compliance Roles ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Get Compliance Role ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Role List Response ### Role Retrieve Response # Permissions ## List Compliance Role Permissions ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### Permission List Response # Settings ## Get effective organization settings ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Setting Retrieve 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: Organizations
3url: https://platform.claude.com/docs/en/api/compliance/organizations
4---
5 
61# Organizations
72 
83## List organizations
94 
10**get** `/v1/compliance/organizations`
5**GET** `/v1/compliance/organizations`
116 
127List organizations under the parent organization.
138 
from line 10
1510`limit` and `page` to paginate: each response includes `has_more` and a
1611`next_page` token to pass on the next request.
1712 
18### Query Parameters
13### Query parameters
1914 
2015- `limit: optional number`
2116 
2217 Maximum results (default: 1000, max: 1000)
2318 
19 default: 1000, maximum: 1000, minimum: 1
20 
2421- `page: optional string`
2522 
2623 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2724 
28### Header Parameters
25### Headers
2926 
3027- `"x-api-key": optional string`
3128 
3229### Returns
3330 
34- `data: array of object { created_at, name, uuid }`
31- `data: array of object`
3532 
3633 List of organizations sorted by creation date, ascending
3734 
from line 54
5754 
5855### Example
5956 
60```http
57```bash
6158curl https://api.anthropic.com/v1/compliance/organizations \
6259 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6360```
6461 
65#### Response
62#### Response (200)
6663 
6764```json
6865{
from line 75
7875}
7976```
8077 
81## Domain Types
78## Domain types
8279 
8380### Organization List Response
8481 
85- `OrganizationListResponse object { created_at, name, uuid }`
82- `OrganizationListResponse object`
8683 
8784 Information about an organization.
8885 
from line 95
9895 
9996 Unique identifier for the organization (UUID format)
10097 
101# Users
102 
103## List organization users
104 
105**get** `/v1/compliance/organizations/{org_uuid}/users`
98## Organizations › Users
99 
100### List organization users
101 
102**GET** `/v1/compliance/organizations/{org_uuid}/users`
106103 
107104List current user members of an organization.
108105 
109### Path Parameters
106#### Path parameters
110107 
111108- `org_uuid: string`
112109 
113110 The organization UUID
114111 
115### Query Parameters
112#### Query parameters
116113 
117114- `limit: optional number`
118115 
119116 Maximum results (default: 500, max: 1000)
120117 
118 default: 500, maximum: 1000, minimum: 1
119 
121120- `page: optional string`
122121 
123122 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
124123 
125### Header Parameters
124#### Headers
126125 
127126- `"x-api-key": optional string`
128127 
129### Returns
130 
131- `data: array of object { id, created_at, email, 2 more }`
128#### Returns
129 
130- `data: array of object`
132131 
133132 List of current organization members sorted by organization join date ascending
134133 
from line 139
140139 
141140 User account creation timestamp
142141 
142 format: date-time
143 
143144 - `email: string`
144145 
145146 User's current email address
from line 179
178179 
179180 Token to retrieve the next page. Use this as the 'page' parameter in your next request
180181 
181### Example
182 
183```http
182#### Example
183 
184```bash
184185curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/users \
185186 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
186187```
187188 
188#### Response
189##### Response (200)
189190 
190191```json
191192{
from line 204
203204}
204205```
205206 
206## Domain Types
207 
208### User List Response
209 
210- `UserListResponse object { id, created_at, email, 2 more }`
211 
212 User member information for compliance responses.
207## Organizations › Roles
208 
209### List Compliance Roles
210 
211**GET** `/v1/compliance/organizations/{org_uuid}/roles`
212 
213List Compliance Roles
214 
215#### Path parameters
216 
217- `org_uuid: string`
218 
219 The organization UUID
220 
221#### Query parameters
222 
223- `limit: optional number`
224 
225 Maximum results (default: 500, max: 1000)
226 
227 default: 500, maximum: 1000, minimum: 1
228 
229- `page: optional string`
230 
231 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
232 
233#### Headers
234 
235- `"x-api-key": optional string`
236 
237#### Returns
238 
239- `data: array of object`
240 
241 List of roles
213242 
214243 - `id: string`
215244 
216 User identifier (tagged ID)
217 
218 - `created_at: string`
219 
220 User account creation timestamp
221 
222 - `email: string`
223 
224 User's current email address
225 
226 - `full_name: string`
227 
228 User's current full name
229 
230 - `organization_role: "admin" or "billing" or "claude_code_user" or 6 more`
231 
232 User's built-in role within the organization. This is distinct from any custom RBAC roles that may also be assigned.
233 
234 - `"admin"`
235 
236 - `"billing"`
237 
238 - `"claude_code_user"`
239 
240 - `"developer"`
241 
242 - `"managed"`
243 
244 - `"membership_admin"`
245 
246 - `"owner"`
247 
248 - `"primary_owner"`
249 
250 - `"user"`
251 
252# Roles
253 
254## List Compliance Roles
255 
256**get** `/v1/compliance/organizations/{org_uuid}/roles`
257 
258List Compliance Roles
259 
260### Path Parameters
261 
262- `org_uuid: string`
263 
264 The organization UUID
265 
266### Query Parameters
267 
268- `limit: optional number`
269 
270 Maximum results (default: 500, max: 1000)
271 
272- `page: optional string`
273 
274 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
275 
276### Header Parameters
277 
278- `"x-api-key": optional string`
279 
280### Returns
281 
282- `data: array of object { id, created_at, description, 2 more }`
283 
284 List of roles
285 
286 - `id: string`
287 
288245 Role identifier (tagged ID)
289246 
290247 - `created_at: string or null`
from line 268
311268 
312269 Token to retrieve the next page. Use this as the 'page' parameter in your next request
313270 
314### Example
315 
316```http
271#### Example
272 
273```bash
317274curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \
318275 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
319276```
320277 
321#### Response
278##### Response (200)
322279 
323280```json
324281{
from line 293
336293}
337294```
338295 
339## Get Compliance Role
340 
341**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
296### Get Compliance Role
297 
298**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
342299 
343300Get Compliance Role
344301 
345### Path Parameters
302#### Path parameters
346303 
347304- `org_uuid: string`
348305 
from line 309
352309 
353310 The role ID (tagged ID, e.g., rbac_role_abc123)
354311 
355### Header Parameters
312#### Headers
356313 
357314- `"x-api-key": optional string`
358315 
359### Returns
316#### Returns
360317 
361318- `id: string`
362319 
from line 335
378335 
379336 Role last-updated timestamp (ISO 8601)
380337 
381### Example
382 
383```http
338#### Example
339 
340```bash
384341curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \
385342 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
386343```
387344 
388#### Response
345##### Response (200)
389346 
390347```json
391348{
from line 354
397354}
398355```
399356 
400## Domain Types
401 
402### Role List Response
403 
404- `RoleListResponse object { id, created_at, description, 2 more }`
405 
406 Role information for compliance responses.
407 
408 - `id: string`
409 
410 Role identifier (tagged ID)
411 
412 - `created_at: string or null`
413 
414 Role creation timestamp (ISO 8601)
415 
416 - `description: string`
417 
418 Role description
419 
420 - `name: string`
421 
422 Role name
423 
424 - `updated_at: string or null`
425 
426 Role last-updated timestamp (ISO 8601)
427 
428### Role Retrieve Response
429 
430- `RoleRetrieveResponse object { id, created_at, description, 2 more }`
431 
432 Role information for compliance responses.
433 
434 - `id: string`
435 
436 Role identifier (tagged ID)
437 
438 - `created_at: string or null`
439 
440 Role creation timestamp (ISO 8601)
441 
442 - `description: string`
443 
444 Role description
445 
446 - `name: string`
447 
448 Role name
449 
450 - `updated_at: string or null`
451 
452 Role last-updated timestamp (ISO 8601)
453 
454# Permissions
455 
456## List Compliance Role Permissions
457 
458**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
357## Organizations › Roles › Permissions
358 
359### List Compliance Role Permissions
360 
361**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
459362 
460363List Compliance Role Permissions
461364 
462### Path Parameters
365#### Path parameters
463366 
464367- `org_uuid: string`
465368 
from line 372
469372 
470373 The role ID (tagged ID, e.g., rbac_role_abc123)
471374 
472### Query Parameters
375#### Query parameters
473376 
474377- `limit: optional number`
475378 
476379 Maximum results (default: 500, max: 1000)
477380 
381 default: 500, maximum: 1000, minimum: 1
382 
478383- `page: optional string`
479384 
480385 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
481386 
482### Header Parameters
387#### Headers
483388 
484389- `"x-api-key": optional string`
485390 
486### Returns
487 
488- `data: array of object { action, resource_id, resource_type }`
391#### Returns
392 
393- `data: array of object`
489394 
490395 List of permissions
491396 
from line 414
509414 
510415 Token to retrieve the next page. Use this as the 'page' parameter in your next request
511416 
512### Example
513 
514```http
417#### Example
418 
419```bash
515420curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
516421 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
517422```
518423 
519#### Response
424##### Response (200)
520425 
521426```json
522427{
from line 437
532437}
533438```
534439 
535## Domain Types
536 
537### Permission List Response
538 
539- `PermissionListResponse object { action, resource_id, resource_type }`
540 
541 Permission granted by a role.
542 
543 - `action: string`
544 
545 Action permitted on the resource
546 
547 - `resource_id: string`
548 
549 Identifier of the resource the permission applies to
550 
551 - `resource_type: string`
552 
553 Type of resource the permission applies to
554 
555# Settings
556 
557## Get effective organization settings
558 
559**get** `/v1/compliance/organizations/{organization_id}/settings`
440## Organizations › Settings
441 
442### Get effective organization settings
443 
444**GET** `/v1/compliance/organizations/{organization_id}/settings`
560445 
561446Retrieve the effective settings for an organization.
562447 
from line 454
569454The organization must belong to the API key's organization hierarchy;
570455unknown organizations and organizations outside the hierarchy return 404.
571456 
572### Path Parameters
457#### Path parameters
573458 
574459- `organization_id: string`
575460 
576461 The organization's UUID
577462 
578### Header Parameters
463#### Headers
579464 
580465- `"x-api-key": optional string`
581466 
582### Returns
583 
584- `api_keys: array of object { id, created_at, created_by_id, 5 more }`
467#### Returns
468 
469- `api_keys: array of object`
585470 
586471 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
587472 
from line 478
593478 
594479 When the key was created.
595480 
481 format: date-time
482 
596483 - `created_by_id: string or null`
597484 
598485 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
from line 500
613500 
614501 When the key will stop authenticating, or null when the key does not expire.
615502 
503 format: date-time
504 
616505 - `type: optional "compliance_api_key"`
617506 
618 - `"compliance_api_key"`
507 default: compliance_api_key
619508 
620509- `organization_id: string`
621510 
622- `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
623 
624 - `Boolean object { name, value, type }`
511- `settings: array of object or object or object or 3 more`
512 
513 - `Boolean object`
625514 
626515 A setting whose enforced value is a single true/false flag.
627516 
from line 614
725614 
726615 - `type: optional "boolean"`
727616 
728 - `"boolean"`
729 
730 - `Integer object { name, value, type }`
617 default: boolean
618 
619 - `Integer object`
731620 
732621 A setting whose enforced value is a whole number; null means no limit
733622 is in force.
734623 
735624 - `name: "account_session_duration_seconds"`
736625 
737 - `"account_session_duration_seconds"`
738 
739626 - `value: number or null`
740627 
741628 - `type: optional "integer"`
742629 
743 - `"integer"`
744 
745 - `String object { name, value, type }`
630 default: integer
631 
632 - `String object`
746633 
747634 A setting whose enforced value is a single string; null means no value
748635 is configured.
from line 644
757644 
758645 - `type: optional "string"`
759646 
760 - `"string"`
761 
762 - `StringList object { name, value, type }`
647 default: string
648 
649 - `StringList object`
763650 
764651 A setting whose enforced value is a list of strings.
765652 
from line 662
775662 
776663 - `type: optional "string_list"`
777664 
778 - `"string_list"`
779 
780 - `ProvisioningMode object { value, name, type }`
665 default: string_list
666 
667 - `ProvisioningMode object`
781668 
782669 How organization members are provisioned, resolved to the enforced mode.
783670 
from line 689
802689 
803690 - `name: optional "sso_provisioning_mode"`
804691 
805 - `"sso_provisioning_mode"`
692 default: sso_provisioning_mode
806693 
807694 - `type: optional "provisioning_mode"`
808695 
809 - `"provisioning_mode"`
810 
811 - `DataRetention object { value, name, type }`
696 default: provisioning_mode
697 
698 - `DataRetention object`
812699 
813700 The data retention periods in force, keyed by the type of data they
814701 apply to.
from line 705
818705 administrator-configured retention period is in force for that data type;
819706 Anthropic's service defaults may still apply.
820707 
821 - `value: map[object { duration, timescale, type } or object { type } ]`
822 
823 - `Fixed object { duration, timescale, type }`
708 - `value: map[object or object]`
709 
710 - `Fixed object`
824711 
825712 A fixed retention window measured from each item's last activity.
826713 
from line 721
834721 
835722 - `type: optional "fixed"`
836723 
837 - `"fixed"`
838 
839 - `Indefinite object { type }`
724 default: fixed
725 
726 - `Indefinite object`
840727 
841728 An indefinite retention period: data is kept with no time limit.
842729 
843730 - `type: optional "indefinite"`
844731 
845 - `"indefinite"`
732 default: indefinite
846733 
847734 - `name: optional "data_retention_periods"`
848735 
849 - `"data_retention_periods"`
736 default: data_retention_periods
850737 
851738 - `type: optional "data_retention"`
852739 
853 - `"data_retention"`
740 default: data_retention
854741 
855742- `type: optional "effective_organization_settings"`
856743 
857 - `"effective_organization_settings"`
858 
859### Example
860 
861```http
744 default: effective_organization_settings
745 
746#### Example
747 
748```bash
862749curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \
863750 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
864751```
865752 
866#### Response
753##### Response (200)
867754 
868755```json
869756{
from line 779
892779 "type": "effective_organization_settings"
893780}
894781```
895 
896## Domain Types
897 
898### Setting Retrieve Response
899 
900- `SettingRetrieveResponse object { api_keys, organization_id, settings, type }`
901 
902 The resolved settings in force for one organization at read time.
903 
904 Settings appear at most once each, in a fixed relative order, and values
905 reflect the enforced state. A setting the organization's administrators
906 cannot change — for example, one controlled by Anthropic policy or not
907 available to the organization — is omitted from the list.
908 
909 - `api_keys: array of object { id, created_at, created_by_id, 5 more }`
910 
911 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
912 
913 - `id: string`
914 
915 Unique identifier for the API key.
916 
917 - `created_at: string`
918 
919 When the key was created.
920 
921 - `created_by_id: string or null`
922 
923 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
924 
925 - `is_active: boolean`
926 
927 Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.
928 
929 - `name: string`
930 
931 The name given to the API key when it was created.
932 
933 - `scopes: array of string`
934 
935 The permission scopes granted to the key.
936 
937 - `expires_at: optional string or null`
938 
939 When the key will stop authenticating, or null when the key does not expire.
940 
941 - `type: optional "compliance_api_key"`
942 
943 - `"compliance_api_key"`
944 
945 - `organization_id: string`
946 
947 - `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
948 
949 - `Boolean object { name, value, type }`
950 
951 A setting whose enforced value is a single true/false flag.
952 
953 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more`
954 
955 - `"ai_powered_artifacts_enabled"`
956 
957 - `"api_workbench_feedback_collection_enabled"`
958 
959 - `"artifact_connectors_enabled"`
960 
961 - `"ask_your_org_enabled"`
962 
963 - `"chat_enabled"`
964 
965 - `"claude_ai_chat_sharing_enabled"`
966 
967 - `"claude_ai_feedback_collection_enabled"`
968 
969 - `"claude_ai_integration_sharing_enabled"`
970 
971 - `"claude_code_desktop_bypass_permissions_enabled"`
972 
973 - `"claude_code_desktop_enabled"`
974 
975 - `"claude_code_fast_mode_enabled"`
976 
977 - `"claude_code_metrics_logging_enabled"`
978 
979 - `"claude_code_remote_control_enabled"`
980 
981 - `"claude_code_review_enabled"`
982 
983 - `"claude_code_routines_enabled"`
984 
985 - `"claude_code_security_enabled"`
986 
987 - `"claude_code_trusted_devices_required"`
988 
989 - `"claude_code_web_enabled"`
990 
991 - `"claude_code_workflows_enabled"`
992 
993 - `"claude_design_enabled"`
994 
995 - `"claude_in_slack_enabled"`
996 
997 - `"code_execution_enabled"`
998 
999 - `"code_execution_network_egress_enabled"`
1000 
1001 - `"connector_tools_default_always_allow"`
1002 
1003 - `"content_redaction_enabled"`
1004 
1005 - `"cowork_trusted_devices_required"`
1006 
1007 - `"desktop_extension_allowlist_enabled"`
1008 
1009 - `"directory_sync_enabled"`
1010 
1011 - `"frontier_data_use_enabled"`
1012 
1013 - `"group_skill_sharing_enabled"`
1014 
1015 - `"hipaa_compliance_enabled"`
1016 
1017 - `"inline_visualizations_enabled"`
1018 
1019 - `"ip_allowlist_enabled"`
1020 
1021 - `"location_metadata_enabled"`
1022 
1023 - `"member_usage_dashboard_visible"`
1024 
1025 - `"memory_enabled"`
1026 
1027 - `"org_wide_skill_sharing_enabled"`
1028 
1029 - `"public_projects_enabled"`
1030 
1031 - `"skill_sharing_enabled"`
1032 
1033 - `"skills_enabled"`
1034 
1035 - `"sso_claude_ai_enforced"`
1036 
1037 - `"sso_console_enforced"`
1038 
1039 - `"sso_enabled"`
1040 
1041 - `"third_party_interactive_content_enabled"`
1042 
1043 - `"user_skill_creation_enabled"`
1044 
1045 - `"web_search_enabled"`
1046 
1047 - `"work_across_apps_enabled"`
1048 
1049 - `value: boolean`
1050 
1051 - `type: optional "boolean"`
1052 
1053 - `"boolean"`
1054 
1055 - `Integer object { name, value, type }`
1056 
1057 A setting whose enforced value is a whole number; null means no limit
1058 is in force.
1059 
1060 - `name: "account_session_duration_seconds"`
1061 
1062 - `"account_session_duration_seconds"`
1063 
1064 - `value: number or null`
1065 
1066 - `type: optional "integer"`
1067 
1068 - `"integer"`
1069 
1070 - `String object { name, value, type }`
1071 
1072 A setting whose enforced value is a single string; null means no value
1073 is configured.
1074 
1075 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
1076 
1077 - `"claude_code_default_worker_environment_id"`
1078 
1079 - `"claude_code_default_worker_pool_id"`
1080 
1081 - `value: string or null`
1082 
1083 - `type: optional "string"`
1084 
1085 - `"string"`
1086 
1087 - `StringList object { name, value, type }`
1088 
1089 A setting whose enforced value is a list of strings.
1090 
1091 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
1092 
1093 - `"allowed_invite_domains"`
1094 
1095 - `"disabled_admin_request_types"`
1096 
1097 - `"ip_allowlist_ip_ranges"`
1098 
1099 - `value: array of string`
1100 
1101 - `type: optional "string_list"`
1102 
1103 - `"string_list"`
1104 
1105 - `ProvisioningMode object { value, name, type }`
1106 
1107 How organization members are provisioned, resolved to the enforced mode.
1108 
1109 A configured mode is reported only while the mechanism that enforces it is
1110 active: just-in-time modes require single sign-on to be enabled, and SCIM
1111 modes require directory sync to be enabled. Otherwise `login_only` is
1112 reported, regardless of any stored configuration.
1113 
1114 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
1115 
1116 How organization members are provisioned under SSO.
1117 
1118 - `"jit_advanced"`
1119 
1120 - `"jit_permissive"`
1121 
1122 - `"login_only"`
1123 
1124 - `"scim_advanced"`
1125 
1126 - `"scim_permissive"`
1127 
1128 - `name: optional "sso_provisioning_mode"`
1129 
1130 - `"sso_provisioning_mode"`
1131 
1132 - `type: optional "provisioning_mode"`
1133 
1134 - `"provisioning_mode"`
1135 
1136 - `DataRetention object { value, name, type }`
1137 
1138 The data retention periods in force, keyed by the type of data they
1139 apply to.
1140 
1141 A key of `all` covers every data type and is exclusive: when present it
1142 is the only key. A missing key means no organization-level
1143 administrator-configured retention period is in force for that data type;
1144 Anthropic's service defaults may still apply.
1145 
1146 - `value: map[object { duration, timescale, type } or object { type } ]`
1147 
1148 - `Fixed object { duration, timescale, type }`
1149 
1150 A fixed retention window measured from each item's last activity.
1151 
1152 - `duration: number`
1153 
1154 - `timescale: "day" or "month"`
1155 
1156 - `"day"`
1157 
1158 - `"month"`
1159 
1160 - `type: optional "fixed"`
1161 
1162 - `"fixed"`
1163 
1164 - `Indefinite object { type }`
1165 
1166 An indefinite retention period: data is kept with no time limit.
1167 
1168 - `type: optional "indefinite"`
1169 
1170 - `"indefinite"`
1171 
1172 - `name: optional "data_retention_periods"`
1173 
1174 - `"data_retention_periods"`
1175 
1176 - `type: optional "data_retention"`
1177 
1178 - `"data_retention"`
1179 
1180 - `type: optional "effective_organization_settings"`
1181 
1182 - `"effective_organization_settings"`
1183782 

api/compliance/organizations/list Changed · +11 / -14 lines

# List organizations ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List organizations ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List organizations
3url: https://platform.claude.com/docs/en/api/compliance/organizations/list
4---
1# List organizations
52 
6## List organizations
3**GET** `/v1/compliance/organizations`
74 
8**get** `/v1/compliance/organizations`
9 
105List organizations under the parent organization.
116 
127Returns organizations sorted by creation date in ascending order. Use
from line 8
138`limit` and `page` to paginate: each response includes `has_more` and a
149`next_page` token to pass on the next request.
1510 
16### Query Parameters
11## Query parameters
1712 
1813- `limit: optional number`
1914 
2015 Maximum results (default: 1000, max: 1000)
2116 
17 default: 1000, maximum: 1000, minimum: 1
18 
2219- `page: optional string`
2320 
2421 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2522 
26### Header Parameters
23## Headers
2724 
2825- `"x-api-key": optional string`
2926 
30### Returns
27## Returns
3128 
32- `data: array of object { created_at, name, uuid }`
29- `data: array of object`
3330 
3431 List of organizations sorted by creation date, ascending
3532 
from line 50
5350 
5451 Token to retrieve the next page. Use this as the 'page' parameter in your next request
5552 
56### Example
53## Example
5754 
58```http
55```bash
5956curl https://api.anthropic.com/v1/compliance/organizations \
6057 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6158```
6259 
63#### Response
60### Response (200)
6461 
6562```json
6663{

api/compliance/organizations/roles Changed · +34 / -55 lines

### Path parameters ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## Roles › Permissions ### List Compliance Role Permissions #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Path Parameters ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Permissions ## List Compliance Role Permissions ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### Permission List Response

from line 1
1---
2title: Roles
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles
4---
5 
61# Roles
72 
83## List Compliance Roles
94 
10**get** `/v1/compliance/organizations/{org_uuid}/roles`
5**GET** `/v1/compliance/organizations/{org_uuid}/roles`
116 
127List Compliance Roles
138 
14### Path Parameters
9### Path parameters
1510 
1611- `org_uuid: string`
1712 
1813 The organization UUID
1914 
20### Query Parameters
15### Query parameters
2116 
2217- `limit: optional number`
2318 
2419 Maximum results (default: 500, max: 1000)
2520 
21 default: 500, maximum: 1000, minimum: 1
22 
2623- `page: optional string`
2724 
2825 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2926 
30### Header Parameters
27### Headers
3128 
3229- `"x-api-key": optional string`
3330 
3431### Returns
3532 
36- `data: array of object { id, created_at, description, 2 more }`
33- `data: array of object`
3734 
3835 List of roles
3936 
from line 64
6764 
6865### Example
6966 
70```http
67```bash
7168curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \
7269 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
7370```
7471 
75#### Response
72#### Response (200)
7673 
7774```json
7875{
from line 89
9289 
9390## Get Compliance Role
9491 
95**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
92**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
9693 
9794Get Compliance Role
9895 
99### Path Parameters
96### Path parameters
10097 
10198- `org_uuid: string`
10299 
from line 103
106103 
107104 The role ID (tagged ID, e.g., rbac_role_abc123)
108105 
109### Header Parameters
106### Headers
110107 
111108- `"x-api-key": optional string`
112109 
from line 131
134131 
135132### Example
136133 
137```http
134```bash
138135curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \
139136 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
140137```
141138 
142#### Response
139#### Response (200)
143140 
144141```json
145142{
from line 148
151148}
152149```
153150 
154## Domain Types
151## Domain types
155152 
156153### Role List Response
157154 
158- `RoleListResponse object { id, created_at, description, 2 more }`
155- `RoleListResponse object`
159156 
160157 Role information for compliance responses.
161158 
from line 178
181178 
182179### Role Retrieve Response
183180 
184- `RoleRetrieveResponse object { id, created_at, description, 2 more }`
181- `RoleRetrieveResponse object`
185182 
186183 Role information for compliance responses.
187184 
from line 202
205202 
206203 Role last-updated timestamp (ISO 8601)
207204 
208# Permissions
205## Roles › Permissions
209206 
210## List Compliance Role Permissions
207### List Compliance Role Permissions
211208 
212**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
209**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
213210 
214211List Compliance Role Permissions
215212 
216### Path Parameters
213#### Path parameters
217214 
218215- `org_uuid: string`
219216 
from line 220
223220 
224221 The role ID (tagged ID, e.g., rbac_role_abc123)
225222 
226### Query Parameters
223#### Query parameters
227224 
228225- `limit: optional number`
229226 
230227 Maximum results (default: 500, max: 1000)
231228 
229 default: 500, maximum: 1000, minimum: 1
230 
232231- `page: optional string`
233232 
234233 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
235234 
236### Header Parameters
235#### Headers
237236 
238237- `"x-api-key": optional string`
239238 
240### Returns
239#### Returns
241240 
242- `data: array of object { action, resource_id, resource_type }`
241- `data: array of object`
243242 
244243 List of permissions
245244 
from line 262
263262 
264263 Token to retrieve the next page. Use this as the 'page' parameter in your next request
265264 
266### Example
265#### Example
267266 
268```http
267```bash
269268curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
270269 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
271270```
272271 
273#### Response
272##### Response (200)
274273 
275274```json
276275{
from line 284
285284 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
286285}
287286```
288 
289## Domain Types
290 
291### Permission List Response
292 
293- `PermissionListResponse object { action, resource_id, resource_type }`
294 
295 Permission granted by a role.
296 
297 - `action: string`
298 
299 Action permitted on the resource
300 
301 - `resource_id: string`
302 
303 Identifier of the resource the permission applies to
304 
305 - `resource_type: string`
306 
307 Type of resource the permission applies to
308287 

api/compliance/organizations/roles/list Changed · +12 / -15 lines

# List Compliance Roles ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Compliance Roles ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List Compliance Roles
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/list
4---
1# List Compliance Roles
52 
6## List Compliance Roles
3**GET** `/v1/compliance/organizations/{org_uuid}/roles`
74 
8**get** `/v1/compliance/organizations/{org_uuid}/roles`
9 
105List Compliance Roles
116 
12### Path Parameters
7## Path parameters
138 
149- `org_uuid: string`
1510 
1611 The organization UUID
1712 
18### Query Parameters
13## Query parameters
1914 
2015- `limit: optional number`
2116 
2217 Maximum results (default: 500, max: 1000)
2318 
19 default: 500, maximum: 1000, minimum: 1
20 
2421- `page: optional string`
2522 
2623 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2724 
28### Header Parameters
25## Headers
2926 
3027- `"x-api-key": optional string`
3128 
32### Returns
29## Returns
3330 
34- `data: array of object { id, created_at, description, 2 more }`
31- `data: array of object`
3532 
3633 List of roles
3734 
from line 60
6360 
6461 Token to retrieve the next page. Use this as the 'page' parameter in your next request
6562 
66### Example
63## Example
6764 
68```http
65```bash
6966curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \
7067 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
7168```
7269 
73#### Response
70### Response (200)
7471 
7572```json
7673{

api/compliance/organizations/roles/permissions Changed · +11 / -14 lines

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

from line 1
1---
2title: Permissions
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions
4---
5 
61# Permissions
72 
83## List Compliance Role Permissions
94 
10**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
5**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
116 
127List Compliance Role Permissions
138 
14### Path Parameters
9### Path parameters
1510 
1611- `org_uuid: string`
1712 
from line 16
2116 
2217 The role ID (tagged ID, e.g., rbac_role_abc123)
2318 
24### Query Parameters
19### Query parameters
2520 
2621- `limit: optional number`
2722 
2823 Maximum results (default: 500, max: 1000)
2924 
25 default: 500, maximum: 1000, minimum: 1
26 
3027- `page: optional string`
3128 
3229 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
3330 
34### Header Parameters
31### Headers
3532 
3633- `"x-api-key": optional string`
3734 
3835### Returns
3936 
40- `data: array of object { action, resource_id, resource_type }`
37- `data: array of object`
4138 
4239 List of permissions
4340 
from line 60
6360 
6461### Example
6562 
66```http
63```bash
6764curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
6865 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6966```
7067 
71#### Response
68#### Response (200)
7269 
7370```json
7471{
from line 81
8481}
8582```
8683 
87## Domain Types
84## Domain types
8885 
8986### Permission List Response
9087 
91- `PermissionListResponse object { action, resource_id, resource_type }`
88- `PermissionListResponse object`
9289 
9390 Permission granted by a role.
9491 

api/compliance/organizations/roles/permissions/list Changed · +12 / -15 lines

# List Compliance Role Permissions ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List Compliance Role Permissions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List Compliance Role Permissions
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list
4---
1# List Compliance Role Permissions
52 
6## List Compliance Role Permissions
3**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
74 
8**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
9 
105List Compliance Role Permissions
116 
12### Path Parameters
7## Path parameters
138 
149- `org_uuid: string`
1510 
from line 14
1914 
2015 The role ID (tagged ID, e.g., rbac_role_abc123)
2116 
22### Query Parameters
17## Query parameters
2318 
2419- `limit: optional number`
2520 
2621 Maximum results (default: 500, max: 1000)
2722 
23 default: 500, maximum: 1000, minimum: 1
24 
2825- `page: optional string`
2926 
3027 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
3128 
32### Header Parameters
29## Headers
3330 
3431- `"x-api-key": optional string`
3532 
36### Returns
33## Returns
3734 
38- `data: array of object { action, resource_id, resource_type }`
35- `data: array of object`
3936 
4037 List of permissions
4138 
from line 56
5956 
6057 Token to retrieve the next page. Use this as the 'page' parameter in your next request
6158 
62### Example
59## Example
6360 
64```http
61```bash
6562curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
6663 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6764```
6865 
69#### Response
66### Response (200)
7067 
7168```json
7269{

api/compliance/organizations/roles/retrieve Changed · +8 / -13 lines

# Get Compliance Role ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get Compliance Role ### Path Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: Get Compliance Role
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/retrieve
4---
1# Get Compliance Role
52 
6## Get Compliance Role
3**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
74 
8**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
9 
105Get Compliance Role
116 
12### Path Parameters
7## Path parameters
138 
149- `org_uuid: string`
1510 
from line 14
1914 
2015 The role ID (tagged ID, e.g., rbac_role_abc123)
2116 
22### Header Parameters
17## Headers
2318 
2419- `"x-api-key": optional string`
2520 
26### Returns
21## Returns
2722 
2823- `id: string`
2924 
from line 40
4540 
4641 Role last-updated timestamp (ISO 8601)
4742 
48### Example
43## Example
4944 
50```http
45```bash
5146curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \
5247 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
5348```
5449 
55#### Response
50### Response (200)
5651 
5752```json
5853{

api/compliance/organizations/settings Changed · +77 / -78 lines

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

from line 1
1---
2title: Settings
3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings
4---
5 
61# Settings
72 
83## Get effective organization settings
94 
10**get** `/v1/compliance/organizations/{organization_id}/settings`
5**GET** `/v1/compliance/organizations/{organization_id}/settings`
116 
127Retrieve the effective settings for an organization.
138 
from line 15
2015The organization must belong to the API key's organization hierarchy;
2116unknown organizations and organizations outside the hierarchy return 404.
2217 
23### Path Parameters
18### Path parameters
2419 
2520- `organization_id: string`
2621 
2722 The organization's UUID
2823 
29### Header Parameters
24### Headers
3025 
3126- `"x-api-key": optional string`
3227 
3328### Returns
3429 
35- `api_keys: array of object { id, created_at, created_by_id, 5 more }`
30- `api_keys: array of object`
3631 
3732 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
3833 
from line 39
4439 
4540 When the key was created.
4641 
42 format: date-time
43 
4744 - `created_by_id: string or null`
4845 
4946 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
from line 61
6461 
6562 When the key will stop authenticating, or null when the key does not expire.
6663 
64 format: date-time
65 
6766 - `type: optional "compliance_api_key"`
6867 
69 - `"compliance_api_key"`
68 default: compliance_api_key
7069 
7170- `organization_id: string`
7271 
73- `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
72- `settings: array of object or object or object or 3 more`
7473 
75 - `Boolean object { name, value, type }`
74 - `Boolean object`
7675 
7776 A setting whose enforced value is a single true/false flag.
7877 
from line 175
176175 
177176 - `type: optional "boolean"`
178177 
179 - `"boolean"`
178 default: boolean
180179 
181 - `Integer object { name, value, type }`
180 - `Integer object`
182181 
183182 A setting whose enforced value is a whole number; null means no limit
184183 is in force.
from line 184
185184 
186185 - `name: "account_session_duration_seconds"`
187186 
188 - `"account_session_duration_seconds"`
189 
190187 - `value: number or null`
191188 
192189 - `type: optional "integer"`
193190 
194 - `"integer"`
191 default: integer
195192 
196 - `String object { name, value, type }`
193 - `String object`
197194 
198195 A setting whose enforced value is a single string; null means no value
199196 is configured.
from line 205
208205 
209206 - `type: optional "string"`
210207 
211 - `"string"`
208 default: string
212209 
213 - `StringList object { name, value, type }`
210 - `StringList object`
214211 
215212 A setting whose enforced value is a list of strings.
216213 
from line 223
226223 
227224 - `type: optional "string_list"`
228225 
229 - `"string_list"`
226 default: string_list
230227 
231 - `ProvisioningMode object { value, name, type }`
228 - `ProvisioningMode object`
232229 
233230 How organization members are provisioned, resolved to the enforced mode.
234231 
from line 250
253250 
254251 - `name: optional "sso_provisioning_mode"`
255252 
256 - `"sso_provisioning_mode"`
253 default: sso_provisioning_mode
257254 
258255 - `type: optional "provisioning_mode"`
259256 
260 - `"provisioning_mode"`
257 default: provisioning_mode
261258 
262 - `DataRetention object { value, name, type }`
259 - `DataRetention object`
263260 
264261 The data retention periods in force, keyed by the type of data they
265262 apply to.
from line 266
269266 administrator-configured retention period is in force for that data type;
270267 Anthropic's service defaults may still apply.
271268 
272 - `value: map[object { duration, timescale, type } or object { type } ]`
269 - `value: map[object or object]`
273270 
274 - `Fixed object { duration, timescale, type }`
271 - `Fixed object`
275272 
276273 A fixed retention window measured from each item's last activity.
277274 
from line 282
285282 
286283 - `type: optional "fixed"`
287284 
288 - `"fixed"`
285 default: fixed
289286 
290 - `Indefinite object { type }`
287 - `Indefinite object`
291288 
292289 An indefinite retention period: data is kept with no time limit.
293290 
294291 - `type: optional "indefinite"`
295292 
296 - `"indefinite"`
293 default: indefinite
297294 
298295 - `name: optional "data_retention_periods"`
299296 
300 - `"data_retention_periods"`
297 default: data_retention_periods
301298 
302299 - `type: optional "data_retention"`
303300 
304 - `"data_retention"`
301 default: data_retention
305302 
306303- `type: optional "effective_organization_settings"`
307304 
308 - `"effective_organization_settings"`
305 default: effective_organization_settings
309306 
310307### Example
311308 
312```http
309```bash
313310curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \
314311 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
315312```
316313 
317#### Response
314#### Response (200)
318315 
319316```json
320317{
from line 341
344341}
345342```
346343 
347## Domain Types
344## Domain types
348345 
349346### Setting Retrieve Response
350347 
351- `SettingRetrieveResponse object { api_keys, organization_id, settings, type }`
348- `SettingRetrieveResponse object`
352349 
353350 The resolved settings in force for one organization at read time.
354351 
from line 354
357354 cannot change — for example, one controlled by Anthropic policy or not
358355 available to the organization — is omitted from the list.
359356 
360 - `api_keys: array of object { id, created_at, created_by_id, 5 more }`
357 - `api_keys: array of object`
361358 
362359 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
363360 
from line 366
369366 
370367 When the key was created.
371368 
369 format: date-time
370 
372371 - `created_by_id: string or null`
373372 
374373 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
from line 388
389388 
390389 When the key will stop authenticating, or null when the key does not expire.
391390 
391 format: date-time
392 
392393 - `type: optional "compliance_api_key"`
393394 
394 - `"compliance_api_key"`
395 default: compliance_api_key
395396 
396397 - `organization_id: string`
397398 
398 - `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
399 - `settings: array of object or object or object or 3 more`
399400 
400 - `Boolean object { name, value, type }`
401 - `Boolean object`
401402 
402403 A setting whose enforced value is a single true/false flag.
403404 
from line 502
501502 
502503 - `type: optional "boolean"`
503504 
504 - `"boolean"`
505 default: boolean
505506 
506 - `Integer object { name, value, type }`
507 - `Integer object`
507508 
508509 A setting whose enforced value is a whole number; null means no limit
509510 is in force.
from line 511
510511 
511512 - `name: "account_session_duration_seconds"`
512513 
513 - `"account_session_duration_seconds"`
514 
515514 - `value: number or null`
516515 
517516 - `type: optional "integer"`
518517 
519 - `"integer"`
518 default: integer
520519 
521 - `String object { name, value, type }`
520 - `String object`
522521 
523522 A setting whose enforced value is a single string; null means no value
524523 is configured.
from line 532
533532 
534533 - `type: optional "string"`
535534 
536 - `"string"`
535 default: string
537536 
538 - `StringList object { name, value, type }`
537 - `StringList object`
539538 
540539 A setting whose enforced value is a list of strings.
541540 
from line 550
551550 
552551 - `type: optional "string_list"`
553552 
554 - `"string_list"`
553 default: string_list
555554 
556 - `ProvisioningMode object { value, name, type }`
555 - `ProvisioningMode object`
557556 
558557 How organization members are provisioned, resolved to the enforced mode.
559558 
from line 577
578577 
579578 - `name: optional "sso_provisioning_mode"`
580579 
581 - `"sso_provisioning_mode"`
580 default: sso_provisioning_mode
582581 
583582 - `type: optional "provisioning_mode"`
584583 
585 - `"provisioning_mode"`
584 default: provisioning_mode
586585 
587 - `DataRetention object { value, name, type }`
586 - `DataRetention object`
588587 
589588 The data retention periods in force, keyed by the type of data they
590589 apply to.
from line 593
594593 administrator-configured retention period is in force for that data type;
595594 Anthropic's service defaults may still apply.
596595 
597 - `value: map[object { duration, timescale, type } or object { type } ]`
596 - `value: map[object or object]`
598597 
599 - `Fixed object { duration, timescale, type }`
598 - `Fixed object`
600599 
601600 A fixed retention window measured from each item's last activity.
602601 
from line 609
610609 
611610 - `type: optional "fixed"`
612611 
613 - `"fixed"`
612 default: fixed
614613 
615 - `Indefinite object { type }`
614 - `Indefinite object`
616615 
617616 An indefinite retention period: data is kept with no time limit.
618617 
619618 - `type: optional "indefinite"`
620619 
621 - `"indefinite"`
620 default: indefinite
622621 
623622 - `name: optional "data_retention_periods"`
624623 
625 - `"data_retention_periods"`
624 default: data_retention_periods
626625 
627626 - `type: optional "data_retention"`
628627 
629 - `"data_retention"`
628 default: data_retention
630629 
631630 - `type: optional "effective_organization_settings"`
632631 
633 - `"effective_organization_settings"`
632 default: effective_organization_settings
634633 

api/compliance/organizations/settings/retrieve Changed · +47 / -50 lines

# Get effective organization settings ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get effective organization settings ### Path Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: Get effective organization settings
3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve
4---
1# Get effective organization settings
52 
6## Get effective organization settings
3**GET** `/v1/compliance/organizations/{organization_id}/settings`
74 
8**get** `/v1/compliance/organizations/{organization_id}/settings`
9 
105Retrieve the effective settings for an organization.
116 
127Returns the settings currently in force for the given organization — the
from line 13
1813The organization must belong to the API key's organization hierarchy;
1914unknown organizations and organizations outside the hierarchy return 404.
2015 
21### Path Parameters
16## Path parameters
2217 
2318- `organization_id: string`
2419 
2520 The organization's UUID
2621 
27### Header Parameters
22## Headers
2823 
2924- `"x-api-key": optional string`
3025 
31### Returns
26## Returns
3227 
33- `api_keys: array of object { id, created_at, created_by_id, 5 more }`
28- `api_keys: array of object`
3429 
3530 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
3631 
from line 37
4237 
4338 When the key was created.
4439 
40 format: date-time
41 
4542 - `created_by_id: string or null`
4643 
4744 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
from line 59
6259 
6360 When the key will stop authenticating, or null when the key does not expire.
6461 
62 format: date-time
63 
6564 - `type: optional "compliance_api_key"`
6665 
67 - `"compliance_api_key"`
66 default: compliance_api_key
6867 
6968- `organization_id: string`
7069 
71- `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
70- `settings: array of object or object or object or 3 more`
7271 
73 - `Boolean object { name, value, type }`
72 - `Boolean object`
7473 
7574 A setting whose enforced value is a single true/false flag.
7675 
from line 173
174173 
175174 - `type: optional "boolean"`
176175 
177 - `"boolean"`
176 default: boolean
178177 
179 - `Integer object { name, value, type }`
178 - `Integer object`
180179 
181180 A setting whose enforced value is a whole number; null means no limit
182181 is in force.
from line 182
183182 
184183 - `name: "account_session_duration_seconds"`
185184 
186 - `"account_session_duration_seconds"`
187 
188185 - `value: number or null`
189186 
190187 - `type: optional "integer"`
191188 
192 - `"integer"`
189 default: integer
193190 
194 - `String object { name, value, type }`
191 - `String object`
195192 
196193 A setting whose enforced value is a single string; null means no value
197194 is configured.
from line 203
206203 
207204 - `type: optional "string"`
208205 
209 - `"string"`
206 default: string
210207 
211 - `StringList object { name, value, type }`
208 - `StringList object`
212209 
213210 A setting whose enforced value is a list of strings.
214211 
from line 221
224221 
225222 - `type: optional "string_list"`
226223 
227 - `"string_list"`
224 default: string_list
228225 
229 - `ProvisioningMode object { value, name, type }`
226 - `ProvisioningMode object`
230227 
231228 How organization members are provisioned, resolved to the enforced mode.
232229 
from line 248
251248 
252249 - `name: optional "sso_provisioning_mode"`
253250 
254 - `"sso_provisioning_mode"`
251 default: sso_provisioning_mode
255252 
256253 - `type: optional "provisioning_mode"`
257254 
258 - `"provisioning_mode"`
255 default: provisioning_mode
259256 
260 - `DataRetention object { value, name, type }`
257 - `DataRetention object`
261258 
262259 The data retention periods in force, keyed by the type of data they
263260 apply to.
from line 264
267264 administrator-configured retention period is in force for that data type;
268265 Anthropic's service defaults may still apply.
269266 
270 - `value: map[object { duration, timescale, type } or object { type } ]`
267 - `value: map[object or object]`
271268 
272 - `Fixed object { duration, timescale, type }`
269 - `Fixed object`
273270 
274271 A fixed retention window measured from each item's last activity.
275272 
from line 280
283280 
284281 - `type: optional "fixed"`
285282 
286 - `"fixed"`
283 default: fixed
287284 
288 - `Indefinite object { type }`
285 - `Indefinite object`
289286 
290287 An indefinite retention period: data is kept with no time limit.
291288 
292289 - `type: optional "indefinite"`
293290 
294 - `"indefinite"`
291 default: indefinite
295292 
296293 - `name: optional "data_retention_periods"`
297294 
298 - `"data_retention_periods"`
295 default: data_retention_periods
299296 
300297 - `type: optional "data_retention"`
301298 
302 - `"data_retention"`
299 default: data_retention
303300 
304301- `type: optional "effective_organization_settings"`
305302 
306 - `"effective_organization_settings"`
303 default: effective_organization_settings
307304 
308### Example
305## Example
309306 
310```http
307```bash
311308curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \
312309 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
313310```
314311 
315#### Response
312### Response (200)
316313 
317314```json
318315{

api/compliance/organizations/users Changed · +15 / -14 lines

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

from line 1
1---
2title: Users
3url: https://platform.claude.com/docs/en/api/compliance/organizations/users
4---
5 
61# Users
72 
83## List organization users
94 
10**get** `/v1/compliance/organizations/{org_uuid}/users`
5**GET** `/v1/compliance/organizations/{org_uuid}/users`
116 
127List current user members of an organization.
138 
14### Path Parameters
9### Path parameters
1510 
1611- `org_uuid: string`
1712 
1813 The organization UUID
1914 
20### Query Parameters
15### Query parameters
2116 
2217- `limit: optional number`
2318 
2419 Maximum results (default: 500, max: 1000)
2520 
21 default: 500, maximum: 1000, minimum: 1
22 
2623- `page: optional string`
2724 
2825 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2926 
30### Header Parameters
27### Headers
3128 
3229- `"x-api-key": optional string`
3330 
3431### Returns
3532 
36- `data: array of object { id, created_at, email, 2 more }`
33- `data: array of object`
3734 
3835 List of current organization members sorted by organization join date ascending
3936 
from line 42
4542 
4643 User account creation timestamp
4744 
45 format: date-time
46 
4847 - `email: string`
4948 
5049 User's current email address
from line 84
8584 
8685### Example
8786 
88```http
87```bash
8988curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/users \
9089 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
9190```
9291 
93#### Response
92#### Response (200)
9493 
9594```json
9695{
from line 107
108107}
109108```
110109 
111## Domain Types
110## Domain types
112111 
113112### User List Response
114113 
115- `UserListResponse object { id, created_at, email, 2 more }`
114- `UserListResponse object`
116115 
117116 User member information for compliance responses.
118117 
from line 122
123122 - `created_at: string`
124123 
125124 User account creation timestamp
125 
126 format: date-time
126127 
127128 - `email: string`
128129 

api/compliance/organizations/users/list Changed · +14 / -15 lines

# List organization users ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List organization users ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1
1---
2title: List organization users
3url: https://platform.claude.com/docs/en/api/compliance/organizations/users/list
4---
1# List organization users
52 
6## List organization users
3**GET** `/v1/compliance/organizations/{org_uuid}/users`
74 
8**get** `/v1/compliance/organizations/{org_uuid}/users`
9 
105List current user members of an organization.
116 
12### Path Parameters
7## Path parameters
138 
149- `org_uuid: string`
1510 
1611 The organization UUID
1712 
18### Query Parameters
13## Query parameters
1914 
2015- `limit: optional number`
2116 
2217 Maximum results (default: 500, max: 1000)
2318 
19 default: 500, maximum: 1000, minimum: 1
20 
2421- `page: optional string`
2522 
2623 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
2724 
28### Header Parameters
25## Headers
2926 
3027- `"x-api-key": optional string`
3128 
32### Returns
29## Returns
3330 
34- `data: array of object { id, created_at, email, 2 more }`
31- `data: array of object`
3532 
3633 List of current organization members sorted by organization join date ascending
3734 
from line 40
4340 
4441 User account creation timestamp
4542 
43 format: date-time
44 
4645 - `email: string`
4746 
4847 User's current email address
from line 80
8180 
8281 Token to retrieve the next page. Use this as the 'page' parameter in your next request
8382 
84### Example
83## Example
8584 
86```http
85```bash
8786curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/users \
8887 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
8988```
9089 
91#### Response
90### Response (200)
9291 
9392```json
9493{

api/files Changed · +90 / -39 lines

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

from line 1
1---
2title: Files
3url: https://platform.claude.com/docs/en/api/files
4---
5 
61# Files
72 
83## Upload File
94 
10**post** `/v1/files`
5**POST** `/v1/files`
116 
127Upload File
138 
9### Body parameters (form-data)
10 
11- `file: string`
12 
13 The file to upload
14 
15 format: binary
16 
17- `expires_in_seconds: optional number`
18 
19 Seconds from upload until the file expires and its bytes become permanently unavailable. Must be between 3600 (one hour) and 7776000 (ninety days).
20 
21 minimum: 3600, maximum: 7776000
22 
1423### Returns
1524 
16- `FileMetadata object { id, created_at, filename, 5 more }`
25- `FileMetadata object`
1726 
1827 - `id: string`
1928 
from line 34
2534 
2635 RFC 3339 datetime string representing when the file was created.
2736 
37 format: date-time
38 
2839 - `filename: string`
2940 
3041 Original filename of the uploaded file.
3142 
43 maxLength: 500, minLength: 1
44 
3245 - `mime_type: string`
3346 
3447 MIME type of the file.
3548 
49 maxLength: 255, minLength: 1
50 
3651 - `size_bytes: number`
3752 
3853 Size of the file in bytes.
3954 
55 minimum: 0
56 
4057 - `type: "file"`
4158 
4259 Object type.
from line 60
4360 
4461 For files, this is always `"file"`.
4562 
46 - `"file"`
47 
4863 - `downloadable: optional boolean`
4964 
5065 Whether the file can be downloaded.
5166 
67 default: false
68 
5269 - `expires_at: optional string or null`
5370 
5471 RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.
5572 
73 format: date-time
74 
5675### Example
5776 
58```http
77```bash
5978curl https://api.anthropic.com/v1/files \
6079 -H 'Content-Type: multipart/form-data' \
6180 -H 'anthropic-version: 2023-06-01' \
from line 82
6382 -F 'file=@/path/to/file'
6483```
6584 
66#### Response
85#### Response (200)
6786 
6887```json
6988{
from line 99
8099 
81100## List Files
82101 
83**get** `/v1/files`
102**GET** `/v1/files`
84103 
85104List Files
86105 
87### Query Parameters
106### Query parameters
88107 
89108- `ids: optional array of string`
90109 
from line 115
96115 
97116 Defaults to `20`. Ranges from `1` to `1000`.
98117 
118 default: 20, maximum: 1000, minimum: 1
119 
99120- `page: optional string`
100121 
101122 Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`.
from line 137
116137 
117138 RFC 3339 datetime string representing when the file was created.
118139 
140 format: date-time
141 
119142 - `filename: string`
120143 
121144 Original filename of the uploaded file.
122145 
146 maxLength: 500, minLength: 1
147 
123148 - `mime_type: string`
124149 
125150 MIME type of the file.
126151 
152 maxLength: 255, minLength: 1
153 
127154 - `size_bytes: number`
128155 
129156 Size of the file in bytes.
130157 
158 minimum: 0
159 
131160 - `type: "file"`
132161 
133162 Object type.
from line 163
134163 
135164 For files, this is always `"file"`.
136165 
137 - `"file"`
138 
139166 - `downloadable: optional boolean`
140167 
141168 Whether the file can be downloaded.
142169 
170 default: false
171 
143172 - `expires_at: optional string or null`
144173 
145174 RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.
146175 
176 format: date-time
177 
147178- `next_page: optional string or null`
148179 
149180 Opaque cursor for the next page. Supply as `?page=` to fetch the next page; null when there are no more results.
from line 181
150181 
151182### Example
152183 
153```http
184```bash
154185curl https://api.anthropic.com/v1/files \
155186 -H 'anthropic-version: 2023-06-01' \
156187 -H "X-Api-Key: $ANTHROPIC_API_KEY"
157188```
158189 
159#### Response
190#### Response (200)
160191 
161192```json
162193{
from line 209
178209 
179210## Download File
180211 
181**get** `/v1/files/{file_id}/content`
212**GET** `/v1/files/{file_id}/content`
182213 
183214Download File
184215 
185### Path Parameters
216### Path parameters
186217 
187218- `file_id: string`
188219 
from line 221
190221 
191222### Example
192223 
193```http
224```bash
194225curl https://api.anthropic.com/v1/files/$FILE_ID/content \
195226 -H 'anthropic-version: 2023-06-01' \
196227 -H "X-Api-Key: $ANTHROPIC_API_KEY"
from line 229
198229 
199230## Get File Metadata
200231 
201**get** `/v1/files/{file_id}`
232**GET** `/v1/files/{file_id}`
202233 
203234Get File Metadata
204235 
205### Path Parameters
236### Path parameters
206237 
207238- `file_id: string`
208239 
from line 241
210241 
211242### Returns
212243 
213- `FileMetadata object { id, created_at, filename, 5 more }`
244- `FileMetadata object`
214245 
215246 - `id: string`
216247 
from line 253
222253 
223254 RFC 3339 datetime string representing when the file was created.
224255 
256 format: date-time
257 
225258 - `filename: string`
226259 
227260 Original filename of the uploaded file.
228261 
262 maxLength: 500, minLength: 1
263 
229264 - `mime_type: string`
230265 
231266 MIME type of the file.
232267 
268 maxLength: 255, minLength: 1
269 
233270 - `size_bytes: number`
234271 
235272 Size of the file in bytes.
236273 
274 minimum: 0
275 
237276 - `type: "file"`
238277 
239278 Object type.
from line 279
240279 
241280 For files, this is always `"file"`.
242281 
243 - `"file"`
244 
245282 - `downloadable: optional boolean`
246283 
247284 Whether the file can be downloaded.
248285 
286 default: false
287 
249288 - `expires_at: optional string or null`
250289 
251290 RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.
252291 
292 format: date-time
293 
253294### Example
254295 
255```http
296```bash
256297curl https://api.anthropic.com/v1/files/$FILE_ID \
257298 -H 'anthropic-version: 2023-06-01' \
258299 -H "X-Api-Key: $ANTHROPIC_API_KEY"
259300```
260301 
261#### Response
302#### Response (200)
262303 
263304```json
264305{
from line 316
275316 
276317## Delete File
277318 
278**delete** `/v1/files/{file_id}`
319**DELETE** `/v1/files/{file_id}`
279320 
280321Delete File
281322 
282### Path Parameters
323### Path parameters
283324 
284325- `file_id: string`
285326 
from line 328
287328 
288329### Returns
289330 
290- `DeletedFile object { id, type }`
331- `DeletedFile object`
291332 
292333 - `id: string`
293334 
from line 340
299340 
300341 For file deletion, this is always `"file_deleted"`.
301342 
302 - `"file_deleted"`
343 default: file_deleted
303344 
304345### Example
305346 
306```http
347```bash
307348curl https://api.anthropic.com/v1/files/$FILE_ID \
308349 -X DELETE \
309350 -H 'anthropic-version: 2023-06-01' \
from line 351
310351 -H "X-Api-Key: $ANTHROPIC_API_KEY"
311352```
312353 
313#### Response
354#### Response (200)
314355 
315356```json
316357{
from line 360
319360}
320361```
321362 
322## Domain Types
363## Domain types
323364 
324365### Deleted File
325366 
326- `DeletedFile object { id, type }`
367- `DeletedFile object`
327368 
328369 - `id: string`
329370 
from line 376
335376 
336377 For file deletion, this is always `"file_deleted"`.
337378 
338 - `"file_deleted"`
379 default: file_deleted
339380 
340381### File Metadata
341382 
342- `FileMetadata object { id, created_at, filename, 5 more }`
383- `FileMetadata object`
343384 
344385 - `id: string`
345386 
from line 392
351392 
352393 RFC 3339 datetime string representing when the file was created.
353394 
395 format: date-time
396 
354397 - `filename: string`
355398 
356399 Original filename of the uploaded file.
357400 
401 maxLength: 500, minLength: 1
402 
358403 - `mime_type: string`
359404 
360405 MIME type of the file.
361406 
407 maxLength: 255, minLength: 1
408 
362409 - `size_bytes: number`
363410 
364411 Size of the file in bytes.
365412 
413 minimum: 0
414 
366415 - `type: "file"`
367416 
368417 Object type.
from line 418
369418 
370419 For files, this is always `"file"`.
371420 
372 - `"file"`
373 
374421 - `downloadable: optional boolean`
375422 
376423 Whether the file can be downloaded.
377424 
425 default: false
426 
378427 - `expires_at: optional string or null`
379428 
380429 RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.
430 
431 format: date-time
381432 

api/files/delete Changed · +9 / -14 lines

# Delete File ## Path parameters ## Returns ## Example ### Response (200) ## Delete File ### Path Parameters ### Returns ### Example #### Response

from line 1
1---
2title: Delete File
3url: https://platform.claude.com/docs/en/api/files/delete
4---
1# Delete File
52 
6## Delete File
3**DELETE** `/v1/files/{file_id}`
74 
8**delete** `/v1/files/{file_id}`
9 
105Delete File
116 
12### Path Parameters
7## Path parameters
138 
149- `file_id: string`
1510 
1611 ID of the File.
1712 
18### Returns
13## Returns
1914 
20- `DeletedFile object { id, type }`
15- `DeletedFile object`
2116 
2217 - `id: string`
2318 
from line 24
2924 
3025 For file deletion, this is always `"file_deleted"`.
3126 
32 - `"file_deleted"`
27 default: file_deleted
3328 
34### Example
29## Example
3530 
36```http
31```bash
3732curl https://api.anthropic.com/v1/files/$FILE_ID \
3833 -X DELETE \
3934 -H 'anthropic-version: 2023-06-01' \
from line 35
4035 -H "X-Api-Key: $ANTHROPIC_API_KEY"
4136```
4237 
43#### Response
38### Response (200)
4439 
4540```json
4641{

api/files/download Changed · +5 / -10 lines

# Download File ## Path parameters ## Example ## Download File ### Path Parameters ### Example

from line 1
1---
2title: Download File
3url: https://platform.claude.com/docs/en/api/files/download
4---
1# Download File
52 
6## Download File
3**GET** `/v1/files/{file_id}/content`
74 
8**get** `/v1/files/{file_id}/content`
9 
105Download File
116 
12### Path Parameters
7## Path parameters
138 
149- `file_id: string`
1510 
1611 ID of the File.
1712 
18### Example
13## Example
1914 
20```http
15```bash
2116curl https://api.anthropic.com/v1/files/$FILE_ID/content \
2217 -H 'anthropic-version: 2023-06-01' \
2318 -H "X-Api-Key: $ANTHROPIC_API_KEY"

api/files/list Changed · +21 / -14 lines

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

from line 1
1---
2title: List Files
3url: https://platform.claude.com/docs/en/api/files/list
4---
1# List Files
52 
6## List Files
3**GET** `/v1/files`
74 
8**get** `/v1/files`
9 
105List Files
116 
12### Query Parameters
7## Query parameters
138 
149- `ids: optional array of string`
1510 
from line 16
2116 
2217 Defaults to `20`. Ranges from `1` to `1000`.
2318 
19 default: 20, maximum: 1000, minimum: 1
20 
2421- `page: optional string`
2522 
2623 Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`.
2724 
28### Returns
25## Returns
2926 
3027- `data: array of FileMetadata`
3128 
from line 38
4138 
4239 RFC 3339 datetime string representing when the file was created.
4340 
41 format: date-time
42 
4443 - `filename: string`
4544 
4645 Original filename of the uploaded file.
4746 
47 maxLength: 500, minLength: 1
48 
4849 - `mime_type: string`
4950 
5051 MIME type of the file.
5152 
53 maxLength: 255, minLength: 1
54 
5255 - `size_bytes: number`
5356 
5457 Size of the file in bytes.
5558 
59 minimum: 0
60 
5661 - `type: "file"`
5762 
5863 Object type.
from line 64
5964 
6065 For files, this is always `"file"`.
6166 
62 - `"file"`
63 
6467 - `downloadable: optional boolean`
6568 
6669 Whether the file can be downloaded.
6770 
71 default: false
72 
6873 - `expires_at: optional string or null`
6974 
7075 RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.
7176 
77 format: date-time
78 
7279- `next_page: optional string or null`
7380 
7481 Opaque cursor for the next page. Supply as `?page=` to fetch the next page; null when there are no more results.
7582 
76### Example
83## Example
7784 
78```http
85```bash
7986curl https://api.anthropic.com/v1/files \
8087 -H 'anthropic-version: 2023-06-01' \
8188 -H "X-Api-Key: $ANTHROPIC_API_KEY"
8289```
8390 
84#### Response
91### Response (200)
8592 
8693```json
8794{

api/files/retrieve_metadata Changed · +20 / -15 lines

# Get File Metadata ## Path parameters ## Returns ## Example ### Response (200) ## Get File Metadata ### Path Parameters ### Returns ### Example #### Response

from line 1
1---
2title: Get File Metadata
3url: https://platform.claude.com/docs/en/api/files/retrieve_metadata
4---
1# Get File Metadata
52 
6## Get File Metadata
3**GET** `/v1/files/{file_id}`
74 
8**get** `/v1/files/{file_id}`
9 
105Get File Metadata
116 
12### Path Parameters
7## Path parameters
138 
149- `file_id: string`
1510 
1611 ID of the File.
1712 
18### Returns
13## Returns
1914 
20- `FileMetadata object { id, created_at, filename, 5 more }`
15- `FileMetadata object`
2116 
2217 - `id: string`
2318 
from line 24
2924 
3025 RFC 3339 datetime string representing when the file was created.
3126 
27 format: date-time
28 
3229 - `filename: string`
3330 
3431 Original filename of the uploaded file.
3532 
33 maxLength: 500, minLength: 1
34 
3635 - `mime_type: string`
3736 
3837 MIME type of the file.
3938 
39 maxLength: 255, minLength: 1
40 
4041 - `size_bytes: number`
4142 
4243 Size of the file in bytes.
4344 
45 minimum: 0
46 
4447 - `type: "file"`
4548 
4649 Object type.
from line 50
4750 
4851 For files, this is always `"file"`.
4952 
50 - `"file"`
51 
5253 - `downloadable: optional boolean`
5354 
5455 Whether the file can be downloaded.
5556 
57 default: false
58 
5659 - `expires_at: optional string or null`
5760 
5861 RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.
5962 
60### Example
63 format: date-time
6164 
62```http
65## Example
66 
67```bash
6368curl https://api.anthropic.com/v1/files/$FILE_ID \
6469 -H 'anthropic-version: 2023-06-01' \
6570 -H "X-Api-Key: $ANTHROPIC_API_KEY"
6671```
6772 
68#### Response
73### Response (200)
6974 
7075```json
7176{
Feedback