Workspace icon

Workspace

Get and change data from Workspace API
Join our community

Actions22

Overview

This node integrates with the Workspace API to retrieve and manipulate various types of data related to workspace management. Specifically, for the User resource with the Get Many operation, it fetches a paginated list of users from the Workspace system. This is useful in scenarios where you need to process or analyze multiple user records, such as generating reports, syncing user data with other systems, or managing user access.

Practical examples include:

  • Fetching all users in batches to update an external CRM.
  • Retrieving user lists for auditing or compliance checks.
  • Displaying user information in dashboards or internal tools.

Properties

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

These properties control pagination of the user list returned by the API.

Output

The node outputs JSON data containing an array of user objects corresponding to the requested page and results per page. Each user object typically includes user details such as ID, name, email, role, and other relevant attributes defined by the Workspace API.

If the API supports binary data for users (e.g., profile pictures), the node would handle this accordingly, but based on the provided code and context, the output focuses on JSON user data.

Dependencies

  • Requires an API key credential and tenant identifier configured in n8n credentials to authenticate requests to the Workspace API.
  • The base URL for the Workspace API must be set in the credentials.
  • The node sends HTTP requests with appropriate headers including Accept, Content-Type, APIKEY, and TENANT.

Troubleshooting

  • Common issues:

    • Invalid or missing API key or tenant values will cause authentication failures.
    • Requesting pages beyond the available range may return empty results.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate invalid credentials; verify API key and tenant settings.
    • Rate limit errors suggest too many requests in a short time; implement retries or reduce request frequency.
    • Unexpected response formats may indicate API changes; check Workspace API documentation for updates.

Links and References

Discussion