Organizations#
See how an AI assistant can help with organizations in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List organizations#
List the organizations the current user belongs to, with their role, plan and number of workspaces.
Tool name: list_organizations. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all organizations in my workspace.What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Get organization#
Retrieve an organization with the workspaces the user can open, each with its share of search, unexplained moments and activities this month, and its people.
Tool name: get_organization. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
Show me the details for this organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
What you'll get back#
Returns { data, _meta } with the result.
Get organization monthly reports#
Retrieve one month for every workspace in the organization the user belongs to: what went out, how brand searches, Share of Search, visits and results compare with the month before and a year earlier, and each workspace share link. Month defaults to last month.
Tool name: get_organization_monthly_reports. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
Show me the details for this organization monthly reports.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| month | string | — | Calendar month in the form YYYY-MM. Defaults to last month. |
What you'll get back#
Returns { data, _meta } with the result.