mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node interacts with the mittwald mStudio API to list customer memberships. Specifically, for the "Customer List Customer Memberships" operation, it retrieves a list of memberships associated with customers. This is useful in scenarios where you want to manage or analyze customer membership data, such as checking active memberships, filtering by role, or paginating through large sets of memberships.

Practical examples include:

  • Fetching all memberships for customers with pagination controls.
  • Filtering memberships that have an expiry date.
  • Retrieving memberships based on user roles like Owner, Member, or Accountant.

Properties

Name Meaning
Limit The maximum number of customer memberships to return (pagination limit).
Skip The number of customer memberships to skip before starting to collect the result set.
Has Expiry Filter memberships by whether they have an expiry date (true or false).
Role Filter memberships by role. Options: Notset, Owner, Member, Accountant.

Output

The node outputs JSON data representing the list of customer memberships retrieved from the mittwald mStudio API. Each item in the output corresponds to a membership record containing details such as membership attributes and possibly metadata about the customer and their role.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de.
  • The node expects the API to respond with JSON data.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token will cause authorization errors.
    • Incorrect property values (e.g., negative numbers for Limit or Skip) may lead to unexpected results or API errors.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Authorization errors typically indicate problems with the API key; ensure the credential is correctly configured.
    • Validation errors from the API may occur if query parameters are out of range or invalid; verify input properties.
    • Timeout or connection errors suggest network problems; retry or check connectivity.

Links and References

Discussion