mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation lists Delivery Boxes associated with a specified Project in the Mail resource of the mittwald mStudio API. It is useful for retrieving and managing mail delivery boxes within a project, enabling users to filter, paginate, and search through available delivery boxes efficiently.

Practical examples include:

  • Fetching all delivery boxes for a given project to display or process them further.
  • Searching delivery boxes by name or description to find specific ones quickly.
  • Paginating through large sets of delivery boxes when dealing with many entries.

Properties

Name Meaning
Project Id ID of the Project to list DeliveryBoxes for. This is required to specify which project's delivery boxes to retrieve.
Search Search term to filter DeliveryBoxes. Searches the fields id (exact match), name, and description (partial matches).
Limit Maximum number of delivery boxes to return in the response. Defaults to 10,000.
Skip Number of items to skip in the result set. Should be a multiple of limit. Used for pagination.
Page Page number to display. Functions similarly to skip. If both page and skip are set, skip takes precedence.

Output

The output JSON contains a list of Delivery Boxes matching the query parameters. Each item typically includes details such as the delivery box's ID, name, description, and other relevant metadata provided by the mittwald mStudio API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de and expects JSON responses.
  • Proper configuration of the API key credential in n8n is necessary for successful requests.

Troubleshooting

  • Empty results: Ensure the Project Id is correct and that there are delivery boxes associated with it.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Pagination issues: When using skip and limit, ensure skip is a multiple of limit to avoid unexpected results.
  • Search not returning expected results: Remember that id requires exact matches, while name and description support partial matches.

Links and References

Discussion