Skip to content
Docs
Groups
List

List groups

API Reference
Zones
Groups

List groups

client.zones.groups.list(stringzoneID, GroupListParams { after, before, expand, 5 more } query?, RequestOptionsoptions?): GroupListResponse { items, pagination }
GET/zones/{zoneId}/groups

Returns 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[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.

ParametersExpand Collapse
zoneID: string
query: GroupListParams { after, before, expand, 5 more }
after?: string

Cursor for forward pagination

minLength1
maxLength255
before?: string

Cursor for backward pagination

minLength1
maxLength255
expand?: "total_count" | "member_count" | "roles" | Array<"total_count" | "member_count" | "roles">
Accepts one of the following:
"total_count" | "member_count" | "roles"
"total_count"
"member_count"
"roles"
Array<"total_count" | "member_count" | "roles">
"total_count"
"member_count"
"roles"
filterID?: string | Array<string>

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

Accepts one of the following:
string
Array<string>
filterIdentifier?: string | Array<string>

Filter by exact group identifier

Accepts one of the following:
string
Array<string>
limit?: number

Maximum number of items to return

minimum1
maximum100
query?: string | Array<string>

Search across name and identifier (substring match)

Accepts one of the following:
string
Array<string>
sort?: string

Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, name, identifier

ReturnsExpand Collapse
GroupListResponse { items, pagination }
items: Array<Group { id, created_at, external, 7 more } >
id: string

Unique identifier of the group

created_at: string

Entity creation timestamp

formatdate-time
external: boolean

Whether the group is synced from an external directory. When true the group is directory-owned and its membership is read-only; when false it is managed in Keycard. Read-only: set by external sync, never by the caller.

identifier: string

User-specified identifier, unique within the zone. Automatically assigned for groups from an external directory.

name: string

Human-readable group name

organization_id: string

Organization this group belongs to

updated_at: string

Entity update timestamp

formatdate-time
zone_id: string

Zone this group belongs to

member_count?: number

Number of users in the group. Included only when requested via expand[]=member_count (group get or list).

roles?: Array<string>

Identifiers of the roles assigned to the group; members inherit them. Deduped across scopes. Included only when requested via expand[]=roles (group get or list).

List groups

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI({
  apiKey: process.env['KEYCARD_API_API_KEY'], // This is the default and can be omitted
});

const groups = await client.zones.groups.list('zoneId');

console.log(groups.items);
{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "external": true,
      "identifier": "identifier",
      "name": "name",
      "organization_id": "organization_id",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id",
      "member_count": 0,
      "roles": [
        "string"
      ]
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "external": true,
      "identifier": "identifier",
      "name": "name",
      "organization_id": "organization_id",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id",
      "member_count": 0,
      "roles": [
        "string"
      ]
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}