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
No line in this hunk matches that.
