Users#
See how an AI assistant can help with users in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List users#
List users in a workspace with pagination and name search.
Tool name: list_users. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all users in my workspace.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| pageIndex | integer | Required | Zero-based page index for pagination. |
| pageSize | integer | Required | Number of items per page (1-100). |
| workspaceId | string (UUID) | Required | Workspace 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. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Get user#
Retrieve a single user by ID.
Tool name: get_user. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
Show me the details for this user.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | User identifier. |
What you'll get back#
Returns { data, _meta } 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. Requests using Brandwave agent access tokens can update only the token owner's profile and cannot change email or other sign-in identity details.
Tool name: update_user. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Update the user.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | User identifier to update. |
| name | string | — | Updated display name (1-255 characters). |
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. |
What you'll get back#
Returns { data, _meta } with the result.
Get user settings#
Retrieve a user's personal settings.
Tool name: get_user_settings. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
Show my personal settings.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | User identifier to fetch settings for. |
What you'll get back#
Returns { data, _meta } with the result.
Update user settings#
Create or update a user's settings, including switching the active workspace and managing UI preferences.
Tool name: update_user_settings. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Switch my active workspace.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | User identifier to update settings for. |
| activeWorkspaceId | string (UUID) | — | Workspace to set as the active workspace. |
| preferences | object | — | User UI preferences (shallow-merged into existing). |
What you'll get back#
Returns { data, _meta } with the result.