List groups
Changed onReturns a paginated list of the groups in the specified zone. Use cursor pagination via after/before. Sort: comma-separated field list; prefix with - for descending (allowed: created_at, name, identifier). Pass expand[]=member_count to include each group's member count, expand[]=roles to include the identifiers of the roles assigned to each group, and expand[]=total_count to include the matching row count. Filter by exact identifier via filter[identifier] (repeatable, OR'd across values). Search via query[] (case-insensitive substring match, OR'd across repeated values); it matches the group's name and identifier. Pass filter[external]=false for only groups managed in Keycard or filter[external]=true for only groups synced from an external directory; omit it to list both. Filter externally synced groups by their directory issuer via filter[external_issuer] (exact match, repeatable, OR'd across values). Pass filter[id] (repeatable, max 100) to restrict results to a known set of groups — mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested group that exists in the zone, in a single page. IDs not in the zone are silently omitted.
Request
- Base URLhttps://docs.keycard.ai (the document declares no server; this is the origin it was published from)
- URLhttps://docs.keycard.ai/zones/{zoneId}/groups
- Auth
- HTTP bearer
- or OAuth 2Client credentialsToken URL: /service-account-token
Path parameters
Zone ID
Query parameters
Cursor for forward pagination
Cursor for backward pagination
Maximum number of items to return
Filter by source: false for groups managed in Keycard, true for groups synced from an external directory. Omit to list both.
Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, name, identifier
Response
Default Response
Changes
- info
added the new optional
queryrequest parameterfilter[external] - info
added the new optional
queryrequest parameterfilter[external_issuer] - info
added the required property
//to the response with the status
- info
- info
endpoint added
- info