SPB Git

Repository Public

members.md 2.3 KB


# title: Members url: https://platform.claude.com/docs/en/api/compliance/groups/members

# Members

# List Compliance Group Members

GET /v1/compliance/groups/{group_id}/members

List Compliance Group Members

# Path parameters

  • group_id: string

    The group ID (tagged ID, e.g., rbac_group_abc123)

# Query parameters

  • limit: optional number

    Maximum results (default: 500, max: 1000)

    default: 500, maximum: 1000, minimum: 1

  • page: optional string

    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.

# Headers

  • "x-api-key": optional string

# Returns

  • data: array of object

    List of group members

    • created_at: string or null

      Membership creation timestamp (RFC 3339)

      format: date-time

    • email: string

      Member email address

    • updated_at: string or null

      Membership last-updated timestamp (RFC 3339)

      format: date-time

    • user_id: string

      Member user identifier (tagged ID)

  • has_more: boolean

    Whether more records exist beyond the current result set

  • next_page: string or null

    Token to retrieve the next page. Use this as the 'page' parameter in your next request

# Example

bash
curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

# Response (200)

json
{
  "data": [
    {
      "created_at": "2025-03-12T18:22:41.123456Z",
      "email": "jane.doe@example.com",
      "updated_at": "2025-03-14T09:05:17.456789Z",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
    }
  ],
  "has_more": true,
  "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}

# Domain types

# Member List Response

  • MemberListResponse object

    Group member for compliance responses.

    • created_at: string or null

      Membership creation timestamp (RFC 3339)

      format: date-time

    • email: string

      Member email address

    • updated_at: string or null

      Membership last-updated timestamp (RFC 3339)

      format: date-time

    • user_id: string

      Member user identifier (tagged ID)

Files main
Menu

Theme