Overview

This node interacts with the Mealie API to retrieve a list of all households managed by the admin. It supports filtering the results using a query filter, pagination to control the number of results per page, and ordering the results by specified fields and directions. This node is useful for administrators who need to manage or review household data within the Mealie system, such as generating reports or syncing household information with other systems.

Use Case Examples

1. An admin wants to fetch all households with a specific attribute using a query filter.
2. An admin needs to paginate through households to display them in a UI with 50 households per page.
3. An admin wants to order households by creation date in descending order for review.

Properties

Output

JSON

• households - Array of household objects returned from the API.
• pagination
  • page - Current page number of the results.
  • perPage - Number of items per page in the results.
  • totalItems - Total number of household items available.
  • totalPages - Total number of pages available based on pagination settings.

Dependencies

• Mealie API with either no authentication or API token authentication

Troubleshooting

• Ensure the API token is valid and has the necessary permissions if using API Token authentication.
• Check the query filter syntax to avoid malformed queries that could cause API errors.
• Verify pagination parameters are within valid ranges to prevent request failures.
• If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.
• If behind a proxy, ensure proxy settings are correctly configured including authentication if required.
• Timeout errors may occur if the server is slow; increase the timeout setting if needed.