Businessmap icon

Businessmap

Use Businessmap API v2

Workspace → Get All Workspaces

AI-generated

Overview

This node operation retrieves a list of workspaces based on specified criteria such as workspace type and archive status. It is useful for scenarios where you need to fetch all workspaces, filter by type, or distinguish between archived and non-archived workspaces. For example, it can be used to display all active project workspaces or to manage archived workspaces for cleanup or review.

Use Case Examples

  1. Fetch all active workspaces of a specific type to display in a dashboard.
  2. Retrieve all archived workspaces for audit or archival purposes.

Properties

Name Meaning
Type Specifies the type of workspaces to search for, allowing filtering by workspace category or classification.
Get All, Archived or Non-Archived Filters workspaces based on their archive status, allowing retrieval of all, only archived, or only non-archived workspaces.

Output

JSON

  • workspaces - An array of workspace objects matching the specified type and archive status criteria.

Troubleshooting

  • Ensure that the workspace type and archive status values are valid and supported by the API or data source.
  • If no workspaces are returned, verify that workspaces exist for the selected type and archive status.
  • Check API authentication and permissions if the node fails to retrieve data.

Discussion