Actions31
Overview
The node integrates with the Steuerboard API to manage and retrieve user data. Specifically, the "User" resource with the "List" operation allows users to fetch a list of users associated with a specified client ID. This is useful in scenarios where you need to programmatically access user information for reporting, synchronization, or administrative purposes.
For example, you might use this node to:
- Retrieve all users belonging to a particular client for auditing.
- Fetch a limited number of users for display in a dashboard.
- Paginate through large sets of users using cursors.
Properties
| Name | Meaning |
|---|---|
| Client ID | The unique identifier of the client whose users you want to list. |
| Return All | Whether to return all users or limit the number of results. Options: true (all), false (limit). |
| Limit | Maximum number of user records to return when not returning all. Range: 1 to 100. |
| Cursor | Pagination cursor used to fetch the next page of results. |
Output
The output contains a JSON array of user objects retrieved from the Steuerboard API. Each object represents a user associated with the specified client. The exact structure of each user object depends on the API response but typically includes user details such as ID, name, email, and other relevant attributes.
If pagination is enabled (Return All set to true), the node will automatically paginate through all available pages using the cursor until all users are retrieved.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Steuerboard API.
- The base URL for the API must be configured in the node credentials.
- Network connectivity to the Steuerboard API endpoint.
Troubleshooting
- Missing or invalid Client ID: The node requires a valid client ID to fetch users. Ensure the client ID is correct and provided.
- API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Pagination issues: If using cursors, ensure the cursor value is valid and corresponds to the previous response's pagination token.
- Rate limits or API errors: The Steuerboard API may enforce rate limits; handle errors gracefully and consider retry logic if needed.
Links and References
- Steuerboard API documentation (refer to your internal or public API docs for detailed user listing endpoints and pagination).
- n8n documentation on pagination and API integrations.