Dukan icon

Dukan

Interact with the Dukan API

Stop Desk → Get Many Stop Desks by Location

AI-generated

Summary

Retrieve multiple stop desks associated with a specified location ID, optionally applying filtering, sorting, pagination, and field selection or population to tailor the returned data.

Inputs

  • Location ID (required) — The unique identifier of the location for which to fetch stop desks.
  • Page Number — The page number of results to retrieve, starting at 1. Defaults to 1.
  • Limit — The maximum number of stop desks to return per request. Defaults to 50.
  • Sort — Fields to sort the returned stop desks by, with the ability to prefix fields with '-' for descending order. Defaults to descending creation date (-createdAt).
  • Populate Fields — Space-separated list of related fields to populate in the returned documents.
  • Select Fields — Space-separated list of stop desk fields to include in the response.
  • Offset — Number of stop desks to skip before starting to collect the result set. Defaults to 0.
  • Filter — A JSON string specifying filter conditions based on MongoDB query operators to narrow results. Defaults to an empty filter {}.
  • Force Custom Auth Header — Whether to override the default authentication key with a custom API key defined in this node.
  • Force Custom Base URL — Whether to override the default base URL with a custom one defined in this node.
  • Custom Base URL — Custom base URL to use for API requests if Force Custom Base URL is enabled.
  • Custom API Key — Custom API key to use for authentication if Force Custom Auth Header is enabled.
  • Request Options — Advanced HTTP request options such as batching, proxy, timeout, and SSL certificate validation settings.

Output shape

a JSON object containing a list of stop desks matching the specified location, with metadata such as pagination details depending on API response.

The response respects pagination parameters (page, limit, offset) and applies sorting, filtering, and field selection/population as specified. If custom authentication or base URL is enabled, those override the node credentials and default endpoints. Errors from the API will be surfaced by the node.

Examples

Example 1: Fetch first 50 stop desks for location 'loc123', sorted by newest creation date, returning only name and state fields.

Set Location ID to 'loc123', leave defaults for page (1), limit (50), sort ('-createdAt'), and select ('name state').

Example 2: Retrieve stop desks for location 'loc789', filter to active desks, populate related 'state' field.

Set Location ID to 'loc789', set filter to '{"status":"active"}', and Populate Fields to 'state'.

Links

Discussion