mittwald icon

mittwald

Interact with mittwald mStudio API

Actions100

Overview

This node operation "Project List Project Memberships" retrieves a list of memberships associated with a specific project from the mittwald mStudio API. It is useful for scenarios where you need to manage or audit user roles and access within projects, such as displaying all members of a project, filtering by role, or checking membership expiry statuses.

Practical examples include:

  • Listing all users who have access to a project along with their roles.
  • Filtering memberships to find only those that are inherited or have an expiry date.
  • Paginating through large membership lists using limit and skip parameters.

Properties

Name Meaning
Limit The maximum number of project memberships to return in one request (pagination control).
Skip The number of project memberships to skip before starting to collect the result set (offset for pagination).
Has Expiry Filter memberships based on whether they have an expiry date (true or false).
Is Inherited Filter memberships based on whether they are inherited (true) or directly assigned (false).
Role Filter memberships by role. Options: Notset, Owner, Emailadmin, External.

Output

The output JSON contains the list of project memberships matching the specified filters and pagination settings. Each item typically includes details about the member, their role, expiry status, and inheritance status.

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

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de.
  • No additional external dependencies beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using invalid filter values (e.g., unsupported role names) may result in empty results or API errors.
    • Pagination parameters (limit and skip) must be non-negative integers; otherwise, the API might reject the request.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; reconfigure credentials.
    • Validation errors on query parameters suggest checking the property values for correctness.
    • Network or timeout errors require verifying connectivity to the mittwald API endpoint.

Links and References

Discussion