Overview

This node interacts with the Workboard API to retrieve all goals with optional filtering, sorting, and pagination. It is useful for scenarios where users need to fetch a list of goals from Workboard, such as for reporting, dashboard displays, or integration with other systems. For example, a user can get all goals with a limit on the number of results, offset for pagination, and sort them by a specific field in ascending or descending order.

Use Case Examples

1. Fetch all goals with a limit of 100 results sorted by creation date in descending order.
2. Retrieve goals starting from the 50th record with a filter to only include active goals.

Properties

Output

JSON

• ``
  • goalId - The unique identifier of each goal
  • name - The name of each goal
  • description - Description or details of each goal
  • status - Current status of each goal
  • dueDate - Due date for each goal
  • owner - Owner or responsible person for each goal
  • additionalProperties - Other properties returned by the Workboard API for each goal

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 query parameters like limit and offset are within acceptable ranges to avoid API errors.
• If the node returns an error, check the error message for details and ensure the requested resource and operation are supported.

Links

• Workboard API Documentation - Official API documentation for Workboard, useful for understanding available endpoints and parameters.