Skip to content

js-bao-wss-client


js-bao-wss-client / ListGroupsOptions

Interface: ListGroupsOptions ​

Filtering and pagination options for groups.list().

Properties ​

cursor? ​

optional cursor?: string

Cursor for fetching the next page of results


includeSystem? ​

optional includeSystem?: boolean

If true, include platform-managed internal groups (those whose groupType is prefixed with _, e.g. _col-reader / _col-writer backing collection sharing). Defaults to false — internal groups are an implementation detail and are not user-meaningful.


limit? ​

optional limit?: number

Maximum number of groups to return per page


type? ​

optional type?: string

If provided, only groups of this type are returned

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30