Actions25
Board → List
AI-generatedOverview
This node operation lists boards within a specified workspace in the Infinity platform. It is useful for retrieving an overview of all boards available in a workspace, which can help in managing projects, tasks, or data organized in boards. For example, a user can list all boards to display them in a dashboard or to select a board for further operations like updating or deleting.
Use Case Examples
- List all boards in a workspace to display project statuses.
- Retrieve a limited number of boards for quick access or summary reports.
Properties
| Name | Meaning |
|---|---|
| Workspace ID | The ID of the workspace from which to list boards. This is required to specify the context for the boards to be listed. |
| Return All | Whether to return all boards or only up to a given limit. If true, all boards are returned; if false, the number of boards returned is limited by the 'Limit' property. |
| Limit | The maximum number of boards to return when 'Return All' is false. It must be between 1 and 100. |
Output
JSON
json- Each item in the output array represents a board object retrieved from the specified workspace. The board object contains details such as board ID, name, description, color, and other metadata as provided by the Infinity API.
Dependencies
- Requires an API key credential for the Infinity API to authenticate requests.
Troubleshooting
- Common issues include invalid workspace ID or insufficient permissions, which may result in errors from the Infinity API.
- If the 'Limit' is set outside the allowed range (1-100), the node may throw an error or return unexpected results.
- Network or API downtime can cause request failures; ensure the Infinity API service is operational.
Links
- Infinity API Boards Documentation - Official API documentation for managing boards in Infinity, useful for understanding the data structure and available operations.