KEkeycardai
Groups

List group role assignments

Changed on

Returns the roles assigned to the group. Members inherit these roles. Returns the shared role-assignment shape with principal_type set to group. Use cursor pagination via after/before; pass expand[]=total_count to include the matching row count. Pass filter[id] (repeatable, max 100) to restrict results to a known set of role assignments, mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested assignment that exists on the group, in a single page. IDs not on the group are silently omitted. Pass filter[scope_id] (repeatable, max 100) to keep only the assignments scoped to those targets, and filter[scoped]=false to keep only unscoped assignments (the ones applying to the zone itself).

get/zones/{zoneId}/groups/{groupId}/roles

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/groups/{groupId}/roles
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

groupIdstring required

Group ID

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
string

Restrict results to the role assignment with this ID. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
string

Restrict results to assignments scoped to this target ID (e.g. a zone ID). Repeatable, max 100; values are OR'd. Unscoped assignments never match.

OR
string[]
filter[scoped]boolean

false keeps only unscoped assignments (those applying to the zone itself, e.g. an org role); true keeps only scoped ones. Omit to list both.

Response

Default Response

Changes