Overview

This node interacts with the Workboard API to perform various operations on different resources such as users, goals, teams, metrics, activities, workstreams, tags, datastreams, and webhooks. Specifically, for the Workstream resource with the 'Get All' operation, it retrieves a list of all workstreams, optionally filtered and sorted based on user-defined query parameters like limit, offset, sort field, sort order, and filter criteria. This node is useful for automating the retrieval of workstream data for reporting, monitoring, or integration with other systems.

Use Case Examples

1. Retrieve all workstreams with a limit of 100 and sorted by name in ascending order.
2. Fetch workstreams with a filter to only include active workstreams.
3. Get a paginated list of workstreams starting from an offset of 50.

Properties

Output

JSON

• ``
  • id - Unique identifier of the workstream
  • name - Name of the workstream
  • description - Description of the workstream
  • created_at - Timestamp when the workstream was created
  • updated_at - Timestamp when the workstream was last updated
  • other_properties - Other properties returned by the Workboard API for each workstream

Dependencies

• Workboard API with JWT Bearer Token authentication

Troubleshooting

• Ensure the Workboard API credentials are correctly configured with a valid bearer token.
• Check the base URL configuration if the API endpoint is unreachable or returns errors.
• Verify that the query parameters are correctly formatted and supported by the API.
• Handle API rate limits or network issues that might cause request failures.
• If the node throws an error, check the error message for details and adjust the input parameters accordingly.

Links

• Workboard API Documentation - Official API documentation for Workboard, detailing endpoints, parameters, and usage.