Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Goal → Get

AI-generated

Overview

This node interacts with the Workboard API to retrieve information about a specific goal based on its ID. It is useful for scenarios where you need to fetch detailed data about a particular goal within the Workboard system, such as in performance tracking, project management, or goal alignment workflows.

Use Case Examples

  1. Retrieve detailed information about a specific goal by providing its Goal ID.
  2. Use the node to fetch goal data for reporting or integration with other systems.

Properties

Name Meaning
Goal ID The ID of the goal to retrieve information for.

Output

JSON

  • id - The unique identifier of the goal.
  • name - The name or title of the goal.
  • description - Detailed description of the goal.
  • status - Current status of the goal (e.g., open, in progress, completed).
  • owner - The owner or responsible person for the goal.
  • due_date - The due date for the goal completion.
  • alignment - Information about goal alignment if included in the response.
  • metrics - Associated metrics related to the goal.

Dependencies

  • Requires an API key credential for authentication with the Workboard API.

Troubleshooting

  • Ensure the provided Goal ID is valid and exists in the Workboard system to avoid 'not found' errors.
  • Check that the API key credential is correctly configured and has the necessary permissions to access goal data.
  • Handle network or API errors gracefully, possibly by enabling 'continue on fail' to avoid workflow interruption.

Links

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

Discussion