Members

envless.members.list()

Read one page of accepted workspace members

ts
list(options?: MemberListOptions): Promise<Page<MemberResource>>

Returns one page of everyone who has accepted membership of the workspace, as items plus the raw pagination envelope. Each row carries the member id that update, remove and the product access routes expect, the assigned role, and the underlying user.

search matches a member name, email or role name, and roleId keeps only the members holding that role. Pending invites are not members and never show up in these rows: read them from the invites namespace.

Example

ts
const page = await envless.members.list({ limit: 50 })

for (const member of page.items) console.log(member.id, member.role?.name, member.user?.email)

Parameters

ParameterTypeRequiredDescription
options.limitnumberNoRows per page, a whole number from 1 to 100.
options.offsetnumberNoRows to skip before the page starts.
options.searchstringNoCase insensitive substring match on the member name, email or role name.
options.roleIdstringNoOnly members holding this role, by the role id from roles.list.
options.signalAbortSignalNoCancels the request.

Returns

Page<MemberResource> with items and the pagination envelope.

Reads the members collection. list returns one page as { items, pagination }, listAll collects every page into an array, and iterate streams one item at a time without buffering the whole set.

Worth knowing

  • The API reads the whole member set and paginates it in memory, so pagination.totalCount is exact.
  • user can be null when the user record cannot be resolved. role is always populated for a real member.
  • A limit above 100 or a fractional offset fails with 400 request.invalid_pagination and error.field names the culprit.

Required scopes

members:read

Underlying endpoint

GET /members

Request and response schema, every error code, and a live playground.

In Python

envless.members.list()

The same method in envless-sdk, the Python SDK, with the same request, retries and errors.

In Ruby

Envless.members.list

The same method in envless-sdk, the Ruby gem, with the same request, retries and errors.

In PHP

$envless->members->list()

The same method in envless/sdk, the PHP SDK, with the same request, retries and errors.