Shopware icon

Shopware

Shopware

Actions778

User Recovery → Search User Recovery

AI-generated

Overview

This node performs a search operation on the User Recovery resource in the Shopware system. It allows users to query user recovery data with various parameters such as pagination (page, limit), filtering, sorting, and field selection. This is useful for scenarios where you need to retrieve specific user recovery records based on complex search criteria, for example, to analyze recovery requests or manage user account recovery processes.

Use Case Examples

  1. Retrieve the first page of user recovery records with a limit of 10 items per page.
  2. Search user recovery entries filtered by specific criteria such as date or user ID.
  3. Sort user recovery results by creation date in descending order.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific conditions.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but exact count), or next-pages (fast count for next pages).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing the returned data.

Output

JSON

  • data - The array of user recovery records matching the search criteria.
  • total - The total number of user recovery records found.
  • aggregations - Aggregation results if any aggregations were requested.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access the User Recovery resource.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times for large datasets; consider using 'next-pages' or 'none' for performance.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion