client.usersOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/usersusers.list
Use this operation to list workspace users. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.users.list(options?: ListOptions)- Return form
Promise- Operation ID
listUsers- Required scopes
users:read- SDK parameters
options: ListOptions- Query request fields
cursor?: stringlimit?: integer- Success
200 Array<User> envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
users.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.users.pages(options?: ListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.