Steuerboard icon

Steuerboard

Consume the Steuerboard API

Actions31

Overview

The node integrates with the Steuerboard API to manage and retrieve data related to various resources, including workspaces. Specifically, the "Workspace - List" operation fetches a list of workspaces associated with a given client ID. This operation supports pagination, allowing users to either retrieve all available workspaces or limit the number of results returned per request.

This node is beneficial in scenarios where you need to programmatically access workspace information for reporting, synchronization, or automation purposes within the Steuerboard platform. For example, you might use it to list all workspaces under a client account to display them in a dashboard or to process workspace data in bulk workflows.

Properties

Name Meaning
Client ID The unique identifier of the client whose workspaces you want to list.
Limit Maximum number of workspace results to return (between 1 and 100). Only used if "Return All" is false.
Return All Whether to return all workspace results by paginating through all pages (true), or only up to the specified limit (false).
Cursor A pagination cursor token used to fetch the next page of workspace results.

Output

The node outputs JSON data containing an array of workspace objects retrieved from the Steuerboard API. Each workspace object includes details as provided by the API (not detailed in the source code). If pagination is enabled ("Return All" set to true), the node automatically handles fetching all pages of results.

No binary data output is indicated or supported by this node.

Dependencies

  • Requires an API key credential for authenticating requests to the Steuerboard API.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests with appropriate headers including Accept: application/json and Content-Type: application/json.
  • Pagination support relies on the API providing a nextCursor token in the response body under pagination.nextCursor.

Troubleshooting

  • Common Issues:

    • Invalid or missing Client ID will result in errors or empty results.
    • Exceeding API rate limits may cause request failures.
    • Incorrect base URL or expired API credentials will prevent successful API calls.
    • Using an invalid or expired pagination cursor can lead to errors or no results.

  • Error Messages:

    • Authentication errors typically indicate issues with the API key or credentials setup.
    • Validation errors may occur if required parameters like Client ID are missing or malformed.
    • Pagination errors may arise if the cursor parameter is incorrect or outdated.

  • Resolutions:

    • Verify that the Client ID is correct and corresponds to an existing client.
    • Ensure API credentials are valid and have necessary permissions.
    • Check the base URL configuration in the node credentials.
    • When paginating, always use the cursor value returned from the previous response.

Links and References

Discussion