Download locations
Generates a CSV export of the selected locations and returns a download URL. The export runs asynchronously — the response confirms the request was accepted, and the user is notified by email when the CSV is ready.
Use selectionType to choose between all matching locations (ALL_ITEMS) or an explicit set (SELECTED_ITEMS with locationIds). The filterInput parameter accepts the same JSON-encoded filter object as Filter locations.
Request
- Base URLhttps://api.synup.com/api/v4
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
JSON-encoded filter object. Defaults to an empty filter (all locations).
Whether to export all matching locations or an explicit selection.
Location IDs to export when selectionType is SELECTED_ITEMS.
Email addresses to notify when the CSV is ready.
Filter by archived state (true/false).
Filter by approved state (true/false).
Return only locations scheduled for archival.
Headers
API version date (YYYY-MM-DD).
API key for authentication.
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.