Dukan icon

Dukan

Interact with the Dukan API

Store Client → Get Many

AI-generated

Summary

Retrieve multiple store client records with optional pagination, filtering, sorting, and field selection from the Dukan API.

Inputs

  • Force Custom Auth Header — Enable to use a custom API key for authentication instead of the node's configured credentials.
  • Force Custom Base URL — Enable to specify a custom Base URL for API requests instead of the URL from the credentials.
  • Custom Base URL — Specify the custom Base URL to use for API requests (without the /v1/external suffix). Requires Force Custom Base URL enabled.
  • Custom API Key — Provide a custom API key to be sent in the request header when Force Custom Auth Header is enabled.
  • Page Number — Set the page number for paginated results (minimum 1). Defaults to 1.
  • Limit — Set the maximum number of store clients to return per page (minimum 1). Defaults to 50.
  • Sort — Define one or more fields to sort the results by. Prefix with '-' for descending order. Example: "name -createdAt".
  • Populate Fields — Specify related fields to populate in the response via space-separated field names.
  • Select Fields — Select which fields to include in the response by providing space-separated field names.
  • Offset — Specify the number of results to skip before starting to collect the result set. Defaults to 0.
  • Filter — Provide a JSON string representing a MongoDB query filter object to filter the store clients retrieved.

Output shape

a JSON array of store client objects matching the query criteria

Supports pagination via Page Number and Limit; filtering supports MongoDB query operators provided as a JSON string; fields in the response can be selected or populated as per user input. Errors will be returned in standard node error format.

Links

Discussion