Workspaces
See how an AI assistant can help with workspaces in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List workspaces
List workspaces the current user belongs to, with membership details.
Tool name: list_workspaces. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
List the workspaces I belong to.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). |
| userId | string (UUID) | Required | User identifier to list workspaces for. |
What you'll get back
Returns { items, totalCount, facets, _meta } with paginated results.
Get workspace refresh status
Retrieve whether workspace metrics are currently updating.
Tool name: get_workspace_refresh_status. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
Show me the details for this workspace refresh status.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
What you'll get back
Returns { data, _meta } with the result.
Get workspace
Retrieve a single workspace by ID.
Tool name: get_workspace. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
Show me the details for this workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Workspace identifier. |
What you'll get back
Returns { data, _meta } with the result.
Create workspace
Create a workspace with a name, timezone, and currency, then assign the requesting user as owner.
Tool name: create_workspace. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.
Example prompt
Create a new workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | User identifier of the workspace owner. |
| organizationId | string (UUID) | — | Organization to add the workspace to. Defaults to the first organization the user owns or administers. |
| name | string | Required | Workspace name, usually the brand. |
| ianaTimezone | 'UTC' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/Anchorage' | 'Pacific/Honolulu' | 'America/Toronto' | 'America/Vancouver' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Australia/Sydney' | 'Australia/Melbourne' | 'Pacific/Auckland' | 'Asia/Tokyo' | 'Asia/Singapore' | null | — | IANA timezone identifier. |
| currency | 'USD' | 'CAD' | 'GBP' | 'EUR' | 'AUD' | 'NZD' | 'JPY' | 'SGD' | — | ISO 4217 currency code. |
What you'll get back
Returns { data, _meta } with the result.
Update workspace
Update a workspace's name, avatar, timezone, currency, or country.
Tool name: update_workspace. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt
Update the workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Workspace identifier to update. |
| name | string | — | Updated workspace name (1-255 characters). |
| avatarKey | string | null | — | Storage key for the workspace avatar image. Set to null to remove. |
| ianaTimezone | 'UTC' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/Anchorage' | 'Pacific/Honolulu' | 'America/Toronto' | 'America/Vancouver' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Australia/Sydney' | 'Australia/Melbourne' | 'Pacific/Auckland' | 'Asia/Tokyo' | 'Asia/Singapore' | null | — | Updated IANA timezone. |
| currency | 'USD' | 'CAD' | 'GBP' | 'EUR' | 'AUD' | 'NZD' | 'JPY' | 'SGD' | — | Updated currency code. |
What you'll get back
Returns { data, _meta } with the result.
Delete workspace
Delete a workspace by marking it deleted rather than permanently erasing its records. Requires workspace-owner permissions. Requests using Brandwave agent access tokens are rejected.
Tool name: delete_workspace. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt
Delete this workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Workspace identifier to delete. |
What you'll get back
Returns { data, _meta } with the result.
This changes data
List workspace users
List users in a workspace with pagination and search.
Tool name: list_workspace_users. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
Who is on my team?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.
Add workspace user
Add any existing Brandwave user account as a pending workspace member with the specified role. Requires workspace-owner permissions. Workspace details and stored aggregate marketing metrics become visible in the recipient's workspace list while pending; acceptance grants role-based workspace access. Does not create an account or send an email.
Tool name: add_workspace_user. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=true, openWorldHint=true.
Example prompt
Add this user to my workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| userId | string (UUID) | Required | User identifier to add. |
| role | 'owner' | 'member' | 'viewer' | Required | Role to assign (owner, member, or viewer). |
What you'll get back
Returns { data, _meta } with the result.
Update workspace user role
Update the role on an existing workspace membership or pending invitation. Requires workspace-owner permissions; cannot change your own role. Does not add a new membership or send a notification.
Tool name: update_workspace_user_role. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt
Make this team member an owner.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| userId | string (UUID) | Required | User identifier whose role is being changed. |
| role | 'owner' | 'member' | 'viewer' | Required | New role to assign (owner, member, or viewer). |
What you'll get back
Returns { data, _meta } with the result.
Remove workspace user
Remove an existing workspace membership or pending invitation by marking it deleted. Requires workspace-owner permissions; cannot remove yourself. Does not delete the user account or send a notification.
Tool name: remove_workspace_user. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt
Remove this member from my workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| userId | string (UUID) | Required | User identifier to remove. |
What you'll get back
Returns { data, _meta } with the result.
Invite workspace user
Invite a user to a workspace by email.
Tool name: invite_workspace_user. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true.
Example prompt
Invite a user to my workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
string | Required | Email address to send the invite to. | |
| workspaceId | string (UUID) | Required | Workspace identifier. |
| role | 'owner' | 'member' | 'viewer' | Required | Role to assign to the invited user (owner, member, or viewer). |
What you'll get back
Returns { data, _meta } with the result.
Authorization required
Get workspace metrics
Fetch workspace-level metrics including total expenses, impressions, social engagement, delivery coverage, and denominator-aware CPM and Social CPE.
Tool name: get_workspace_metrics. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
How is my workspace performing this month?Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
What you'll get back
Returns { data, _meta } with the result.
Get workspace metrics history
Fetch workspace metrics over time with a configurable lookback window.
Tool name: get_workspace_metrics_history. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
Show me how my workspace metrics have trended over time.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| daysBack | integer | — | Number of days of history to return (1-365). |
What you'll get back
Returns { items, totalCount, facets, _meta } with paginated results.
List workspace to-dos
List what needs doing in a workspace right now: promo codes and tagged links to link to marketing, customer answers to group, ended campaigns with no learnings written up, and results to choose once analytics is connected. Each item clears itself once done.
Tool name: list_workspace_todos. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
List all workspace to-dos in my workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace whose waiting housekeeping should be listed. |
What you'll get back
Returns { items, totalCount, facets, _meta } with paginated results.