Dukan icon

Dukan

Interact with the Dukan API

State → Get Many States

AI-generated

Summary

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

Inputs

  • Force Custom Auth Header — Whether to use a custom API key from this node instead of the configured Dukan credentials.
  • Force Custom Base URL — Whether to use a custom Base URL from this node instead of the Base URL in the credentials.
  • Custom Base URL — Base URL for API requests instead of the Base URL from the credentials, without the /v1/external suffix; shown only if Force Custom Base URL is enabled.
  • Custom API Key — API key to send when Force Custom Auth Header is enabled.
  • Page Number — The page number of results to retrieve; defaults to 1.
  • Limit — Maximum number of results to return per request; defaults to 50.
  • Sort — Fields to sort the returned documents by; single or space-separated fields, default is '-createdAt'.
  • Populate Fields — Fields to populate in the returned documents; space-separated field names.
  • Select Fields — Fields to include in the returned documents; space-separated field names.
  • Offset — Number of documents to skip before starting to return results; defaults to 0.
  • Filter — A JSON string representing a MongoDB query filter to narrow the results; defaults to an empty filter '{}'.
  • Request Options — Advanced HTTP request settings including batching, SSL validation, proxy, and timeout configuration.

Output shape

a list of state records as returned by the Dukan API

Supports pagination through 'page' and 'limit' parameters. The filter parameter accepts MongoDB query syntax as a JSON string. Sorting, selecting, and populating fields are supported via respective string parameters. Optional custom authentication and base URL can override node credentials.

Examples

Example 1: Retrieve the first 100 states sorted by name ascending

Set 'Page Number' to 1 and 'Limit' to 100, 'Sort' to 'name'.

Example 2: Fetch states with a specific criteria using a filter

Set 'Filter' to a JSON string matching the desired MongoDB filter.

Links

Discussion