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 'User' resource with the 'Get All' operation, it retrieves a list of all users, supporting query parameters like limit, offset, sorting, and filtering. This is useful for administrators who need to manage or analyze user data within the Workboard platform.

Use Case Examples

1. An administrator wants to fetch all users with pagination and sorting to display in a dashboard.
2. A data analyst needs to retrieve filtered user data based on specific criteria for reporting purposes.

Properties

Output

JSON

• ``
  • id - Unique identifier of the user.
  • name - Name of the user.
  • email - Email address of the user.
  • role - Role assigned to the user.
  • status - Current status of the user (e.g., active, deactivated).

Dependencies

• Workboard API with JWT Bearer Token authentication

Troubleshooting

• Ensure the API credentials (JWT token and base URL) are correctly configured and valid.
• Check that the user has the necessary permissions (Data-Admin) to perform the 'Get All' operation on users.
• Verify that query parameters are correctly formatted and within acceptable ranges to avoid API errors.
• Common error messages include authentication failures, permission denied, and invalid query parameters. Resolving these typically involves updating credentials, adjusting permissions, or correcting parameter values.

Links

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