Workspace and project basics tools

list_cloud_organizations: List the cloud organizations you belong to.
get_cloud_organization_details: Get details for a single cloud organization.
list_workspaces: List workspaces inside a cloud organization.
list_projects: List projects across an organization, with optional workspace filter.
list_projects_with_overview: List projects and pull each project's KPI snapshot in one call.
get_project_overview: Get a KPI snapshot for a single project.

list_cloud_organizations

Returns every cloud organization you have access to. Start here when you don't yet know which organization to work with. The IDs returned by this tool feed into list_workspaces, list_projects, and get_cloud_organization_details.

Request parameters

This tool request doesn't require any parameters.

Response parameters

The tool returns a CloudOrganizationsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[CloudOrganization]`	The organizations you belong to.
`error`	`str \| null`	Error message if the request failed.

The CloudOrganization object has the following fields:

Field	Type	Description
`id`	`str`	The organization's unique ID. Use this as `cloud_organization_id` in other tools.
`name`	`str`	The organization's display name.
`admin_panel_url`	`str \| null`	Relative URL to the admin panel for this organization.
`enabled_modules`	`list[str]`	Feature modules turned on for this organization, for example `SSO_LOGIN`.

get_cloud_organization_details

Returns admin metadata for a single cloud organization, including its domain, supervisor contacts, Salesforce ID, and enabled modules. Call list_cloud_organizations first if you don't know the ID.

Request parameters

Name	Type	Required?	Description
`cloud_organization_id`	`str`	Yes	The organization ID returned by `list_cloud_organizations`.

Response parameters

The tool returns a CloudOrganizationDetailsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`CloudOrganizationDetails \| null`	The full organization record.
`error`	`str \| null`	Error message if the request failed.

The CloudOrganizationDetails object has the following fields:

Field	Type	Description
`id`	`str`	The organization's unique ID.
`name`	`str`	The organization's display name.
`domain`	`str \| null`	The domain registered to the organization.
`enabled_modules`	`list[str]`	Feature modules turned on for this organization.
`supervisor_email`	`str \| null`	Primary supervisor's email.
`internal_supervisor_email`	`str \| null`	Internal supervisor's email.
`salesforce_id`	`str \| null`	The organization's Salesforce CRM identifier.

list_workspaces

Returns the workspaces inside a cloud organization. Each workspace groups one or more projects. Use this when you need to see how projects are organized inside an account, or to find the URL to a workspace in the app.

Request parameters

Name	Type	Required?	Description
`cloud_organization_id`	`str`	Yes	The organization ID returned by `list_cloud_organizations`.

Response parameters

The tool returns a WorkspacesResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[Workspace]`	The workspaces in the organization.
`error`	`str \| null`	Error message if the request failed.

The Workspace object has the following fields:

Field	Type	Description
`id`	`str`	The workspace's unique ID.
`name`	`str`	The workspace's display name.
`url`	`str \| null`	URL that opens this workspace in the app.
`data_engine_url`	`str \| null`	URL to the data engine for this workspace.
`projects`	`list[WorkspaceProject]`	Projects inside this workspace.
`discovery_accounts`	`list[DiscoveryAccount]`	Discovery accounts linked to this workspace.

list_projects

Returns every project in a cloud organization as a flat list. You can optionally narrow results to a single workspace. Each project ID returned here is the project_id other tools need.

Request parameters

Name	Type	Required?	Description
`cloud_organization_id`	`str`	Yes	The organization ID returned by `list_cloud_organizations`.
`workspace_id`	`str \| null`	No	A workspace ID to limit results to one workspace.

Response parameters

The tool returns a ProjectsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[Project]`	A flat list of projects across the organization.
`error`	`str \| null`	Error message if the request failed.

The Project object has the following fields:

Field	Type	Description
`id`	`str`	The project's unique ID. Use this as `project_id` in other tools.
`name`	`str`	The project's display name.
`category`	`str \| null`	The project category, for example `dev`, `test`, or `int`.
`url`	`str \| null`	URL that opens this project in the app.
`workspace_id`	`str`	ID of the workspace this project belongs to.
`workspace_name`	`str`	Name of the workspace this project belongs to.

list_projects_with_overview

Returns every project alongside its KPI snapshot in a single response. This combines list_projects and get_project_overview so you can survey customer counts, event counts, and active campaign counts across an organization without making many separate calls.

Request parameters

Name	Type	Required?	Description
`cloud_organization_id`	`str`	Yes	The organization ID returned by `list_cloud_organizations`.
`workspace_id`	`str \| null`	No	A workspace ID to limit results to one workspace.

Response parameters

The tool returns a ProjectsWithOverviewResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[ProjectWithOverview]`	Projects with their KPI snapshots attached.
`error`	`str \| null`	Error message if the top-level request failed.

The ProjectWithOverview object has the following fields:

Field	Type	Description
`project_id`	`str`	The project's unique ID.
`name`	`str`	The project's display name.
`workspace_id`	`str`	ID of the workspace this project belongs to.
`workspace_name`	`str`	Name of the workspace this project belongs to.
`category`	`str \| null`	The project category, for example `dev`, `test`, or `int`.
`overview`	`any \| null`	The project's KPI snapshot. Null if the overview call failed for this project.
`overview_error`	`str \| null`	Error from the overview fetch, if it failed for this project.

get_project_overview

Returns a high-level health-check for a single project: total customer count, total event count, active campaign counts by channel, and quota usage. Useful when you want one quick look at the size and activity of a project.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns a ProjectOverviewResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`any \| null`	A snapshot of customer counts, event counts, active campaign counts by channel, and quota usage. The exact shape depends on the project's configuration.
`error`	`str \| null`	Error message if the request failed.