KEkeycardai
Groups

List group members

Changed on

Returns a paginated list of the group's members. Use cursor pagination via after/before. Pass expand[]=user to embed each member's full user record and expand[]=total_count to include the matching row count. Pass query[] (repeatable, 1-255 chars) to search members by their user's email or subject (substring match, OR'd across repeated values). Pass filter[id] (repeatable, max 100) to restrict results to a known set of members by user ID — mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested member that exists in the group, in a single page. IDs not in the group are silently omitted.

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

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}/members
  • 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' | 'user'
OR
string[]
string

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

OR
string[]
string

Search members by their user's email or subject (substring match)

OR
string[]

Response

Default Response

Changes

  • 0cfaff865771Revision changes
    • warning

      removed the optional property //////////// from the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

  • d65d51379d93Revision changes
    • info

      endpoint added