Download locations

GET

https://api.synup.com/api/v4/locations/download

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

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff 'https://api.synup.com/api/v4/locations/download?filterInput={%22tags%22%3A[%22priority%22]}&selectionType=ALL_ITEMS&locationIds=&emails=&archived=&approved=&archivalScheduledAt=' \
--header 'Synup-Version: 2026-04-17' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200

application/json

Successful response

Bodyapplication/json

Example

{
    "data": {
        "downloadLocations": {
            "success": true,
            "csvUrl": "string"
        }
    }
}

🟠401

Modified at 2026-07-14 18:08:00

Available advanced filter values

Filter locations