Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Admin Locations → Get Many

AI-generated

Summary

Retrieve a list of administrative locations using optional query parameters sent as a JSON object to filter or modify the request.

Inputs

  • Query Parameters JSON — A JSON object of query parameters to send with the GET request to filter or adjust the list of admin locations returned.
  • Additional Options — Collection of request options including whether to ignore HTTP status errors, return the full HTTP response (status, headers, body), and set a request timeout in milliseconds.

Output shape

a list of admin location items in JSON format

By default, returns only the response body parsed as JSON containing the list of admin locations. If 'Return Full Response' option is enabled, returns an object including HTTP status, headers, and body. Query parameters can be used to filter results. Supports handling error responses without failing the workflow when the corresponding option is enabled.

Examples

Example 1: Retrieve all admin locations without filters

Leave Query Parameters JSON as {} to get all locations.

Example 2: Retrieve admin locations filtered by a certain field

Provide filter parameters in Query Parameters JSON to limit returned locations.

Links

Discussion