Actions31
Overview
The node integrates with the Steuerboard API to manage and retrieve data related to various resources, including clients. Specifically, the Client - List operation fetches a list of client records from the Steuerboard system. This operation is useful when you want to retrieve multiple client entries for reporting, synchronization, or further processing within an n8n workflow.
Common scenarios include:
- Fetching all clients or a subset based on filters such as custom IDs or archived status.
- Paginating through large sets of clients to process them in batches.
- Integrating client data into other systems or dashboards.
For example, you might use this node to pull all active clients (non-archived) up to a certain limit or to iterate through all clients by enabling the "Return All" option.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. If true, paginates automatically. |
| Limit | Max number of results to return (1 to 100). Ignored if "Return All" is true. |
| Filters | Collection of optional filters to narrow down the client list: |
| Custom ID | Return only clients with this specific custom ID. |
| Archived | Whether to include archived clients (true/false). |
| Cursor | Cursor string used for pagination to get the next page of results. |
Output
The node outputs JSON data representing the list of clients retrieved from the Steuerboard API. The structure typically includes an array of client objects with their properties as returned by the API.
If pagination is enabled ("Return All" = true), the node will internally handle fetching all pages and output a combined list.
No binary data output is indicated for this operation.
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 access to the Steuerboard API endpoint.
Troubleshooting
- Empty results: Check filter values like Custom ID or Archived status to ensure they match existing clients.
- Pagination issues: If "Return All" is enabled but fewer results than expected are returned, verify that the API supports pagination correctly and that cursors are handled properly.
- Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
- Limit out of range: The "Limit" property must be between 1 and 100; setting outside this range may cause errors.
- API connectivity: Network or base URL misconfiguration can lead to request failures.
Links and References
- Steuerboard API documentation (not provided here, but recommended to consult for detailed client object schema and pagination behavior).