Mealie icon

Mealie

Interact with Mealie API

Actions59

Admin: Manage Groups → Get All Groups

AI-generated

Overview

This node interacts with the Mealie API to retrieve a list of all groups managed under the Admin: Manage Groups resource. It supports filtering the groups via a query string, pagination to control the number of results per page and the page number, and ordering of the results by specified fields and directions. This node is useful for administrators who need to manage or audit groups within the Mealie system, allowing them to fetch comprehensive or filtered group data efficiently.

Use Case Examples

  1. An admin wants to retrieve all user groups with a specific name pattern using the query filter.
  2. An admin needs to paginate through groups 50 at a time, ordering them by creation date in descending order.
  3. An admin fetches all groups without authentication for public or open data scenarios.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request, either no authentication or API token authentication.
Query Filter A string query to filter the groups returned by the API.
Pagination Parameters to control pagination of the results, including page number, items per page, order by fields, and order direction.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • groups - Array of group objects retrieved from the Mealie API.
  • pagination
    • page - Current page number of the results.
    • perPage - Number of groups returned per page.
    • totalPages - Total number of pages available.
    • totalItems - Total number of groups available.

Dependencies

  • Mealie API

Troubleshooting

  • Authentication errors may occur if the API token is invalid or missing; ensure correct credentials are provided.
  • Query filter syntax errors can cause the API to return no results or errors; verify the query string format.
  • Pagination parameters must be valid numbers; invalid values may cause request failures or unexpected results.
  • Network issues or incorrect proxy settings can cause request failures; verify network connectivity and proxy configuration.
  • SSL certificate validation failures can be bypassed by enabling the 'Ignore SSL Issues' option, but this reduces security.

Links

Discussion