mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation retrieves a list of memberships associated with a specific customer from the mittwald mStudio API. It is useful when you want to fetch all membership records tied to a particular customer, for example, to display their roles or manage access rights within an application.

Practical scenarios include:

  • Displaying all memberships a customer holds in a dashboard.
  • Filtering memberships by role or expiry status.
  • Paginating through large sets of memberships using limit and skip parameters.

Properties

Name Meaning
Customer Id The unique identifier of the customer whose memberships you want to list.
Limit Maximum number of membership records to return (pagination).
Skip Number of membership records to skip before starting to collect the result set (pagination).
Has Expiry Filter memberships based on whether they have an expiry date (true or false).
Role Filter memberships by role. Options: Notset, Owner, Member, Accountant.

Output

The output JSON contains an array of membership objects related to the specified customer. Each object typically includes details such as membership role, expiry information, and other relevant membership metadata as provided by the mittwald mStudio API.

If the node supports binary data output, it would represent any file or media content related to memberships, but this operation primarily returns JSON data.

Dependencies

  • Requires an API key credential for authenticating requests to the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de for API calls.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Invalid Customer Id: If the customer ID is incorrect or does not exist, the API may return an error or empty results. Verify the customer ID before running the node.
  • API Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Pagination Issues: Using inappropriate values for limit or skip might lead to unexpected results or empty responses. Use sensible pagination values.
  • Role Filter Misuse: Selecting an invalid role option will likely cause no results to be returned. Use one of the predefined roles.

Links and References

Discussion