Workspace icon

Workspace

Get and change data from Workspace API
Join our community

Actions22

Overview

The node interacts with the Workspace API to retrieve and manipulate data related to various resources, including Kanban boards. Specifically, for the Kanban resource with the "Get Many" operation, it fetches multiple Kanban cards in a paginated manner. This is useful when you want to list or process batches of Kanban cards from a workspace, such as displaying them in an external dashboard, syncing with other tools, or performing bulk operations.

Practical examples:

  • Fetching the first 10 Kanban cards on page 1 to display in a custom project management dashboard.
  • Iterating through pages of Kanban cards to export all cards to a spreadsheet or another system.

Properties

Name Meaning
Results Per Page Number of Kanban cards to fetch per page (e.g., 10)
Page Page number to fetch (e.g., 1 for the first page)

These properties control pagination of the Kanban cards retrieved from the API.

Output

The node outputs JSON data representing the Kanban cards fetched from the Workspace API. The structure typically includes an array of Kanban card objects, each containing details such as card ID, title, description, status, and other metadata relevant to the Kanban board.

If the API supports binary data for Kanban cards (e.g., attachments), the node would also output this under a binary property, but based on the provided code and context, the primary output is JSON-formatted Kanban card data.

Dependencies

  • Requires connection to the Workspace API via an API key credential and tenant identifier.
  • The node expects these credentials to be configured in n8n with appropriate permissions to access Kanban data.
  • Network connectivity to the Workspace API endpoint specified in the credentials is necessary.

Troubleshooting

  • Common issues:

    • Incorrect API key or tenant configuration leading to authentication errors.
    • Requesting a page number beyond available data returns empty results.
    • Exceeding rate limits imposed by the Workspace API may cause request failures.

  • Error messages:

    • Authentication errors usually indicate invalid or missing API credentials; verify and update credentials accordingly.
    • Pagination errors might occur if "Results Per Page" or "Page" values are set to invalid numbers (e.g., zero or negative); ensure these are positive integers.
    • Network or timeout errors suggest connectivity problems; check network settings and API availability.

Links and References

Discussion