Users#

Manage user profiles and per-user settings.

List users#

List users in an organization with pagination and name search.

typescript

const { items, totalCount, facets } = await bw.users.list({
  pageIndex: 0,
  pageSize: 25,
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
});

Parameters#

Name	Type	Required	Description
pageIndex	`integer`	Required	Zero-based page index for pagination.
pageSize	`integer`	Required	Number of items per page (1-100).
organizationId	`string (UUID)`	Required	Organization identifier.
searchTerm	`string`	—	Free-text search term to filter results (max 200 characters).
sortBy	`string`	—	Column name to sort by.
sortDirection	`'asc' \| 'desc'`	—	Sort direction: ascending or descending.

Response#

Returns { items, totalCount, facets } with paginated results.

Get user#

Retrieve a single user by ID.

typescript

const { data } = await bw.users({ id: 'e2d4a6b8-0c1f-4e3a-95d7-8b6c4a2e0f06' });

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	User identifier.

Response#

Returns { data } with the result.

Update user#

Update a user's profile information. Updatable fields: name (display name), email, jobRole (e.g. 'Head of Marketing'), avatarKey (storage key, null to remove). Only include the fields you want to change.

typescript

const { data } = await bw.users.update({
  userId: '6c9e4b21-8d05-4f7a-b3c2-1e5a9d8f4b07',
});

Parameters#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier to update.
name	`string`	—	Updated display name (1-255 characters).
email	`string`	—	Updated email address.
jobRole	`string \| null`	—	Updated job role (max 100 characters).
avatarKey	`string \| null`	—	Storage key for the user avatar image. Set to null to remove.

Response#

Returns { data } with the result.

Get user settings#

Retrieve a user's personal settings.

typescript

const { data } = await bw.users.settings({
  userId: '6c9e4b21-8d05-4f7a-b3c2-1e5a9d8f4b07',
});

Parameters#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier to fetch settings for.

Response#

Returns { data } with the result.

Update user settings#

Create or update a user's settings, including switching the active organization and managing UI preferences.

typescript

const { data } = await bw.users.settings.update({
  userId: '6c9e4b21-8d05-4f7a-b3c2-1e5a9d8f4b07',
});

Parameters#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier to update settings for.
activeOrganizationId	`string (UUID)`	—	Organization to set as the active workspace.
preferences	`object`	—	User UI preferences (shallow-merged into existing).

Response#

Returns { data } with the result.