Dukan icon

Dukan

Interact with the Dukan API

State → Get One State

AI-generated

Summary

Retrieve details of a single state from the Dukan API using its MongoDB ObjectId.

Inputs

  • State ID (required) — The MongoDB ObjectId string that uniquely identifies the state to retrieve.
  • Force Custom Auth Header — Option to use a custom API key for authentication instead of the node's configured Dukan credentials.
  • Custom API Key — The custom API key to send when the 'Force Custom Auth Header' option is enabled.
  • Force Custom Base URL — Option to use a custom Base URL for the API request instead of the one in credentials.
  • Custom Base URL — The custom base URL to use for API requests when 'Force Custom Base URL' is enabled, excluding the suffix '/v1/external'.
  • Request Options — Additional HTTP request options such as batching, SSL verification behavior, proxy, and timeout configuration.

Output shape

a single JSON object representing the state's data as returned by the Dukan API

The retrieved data corresponds to the state identified by the provided MongoDB ObjectId. Authentication and base URL can be overridden per node run. Request options allow controlling batching, SSL, proxy, and timeout settings. Errors are returned if the state ID is invalid or the API call fails.

Examples

Example 1: Get state details using default credentials

Set the resource to 'State', operation to 'Get One State', and specify the 'State ID'. The node uses configured credentials and base URL.

Example 2: Get state details with a custom API key and base URL

Enable 'Force Custom Auth Header' and enter a custom API key. Enable 'Force Custom Base URL' and specify the custom URL to override default credentials and endpoint.

Links

Discussion