Filter locations

GET

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

Returns a paginated list of locations that match the supplied filters.

The filter criteria are passed as a single JSON-encoded object in the input query parameter. Supported filter keys include name/store/phone search (query, storeId, phone), location identifiers (ids), package tier (package), tags, folders, categories, address filters (postalCode, city, stateIso), custom attributes (customAttributes), GBP categories (primaryGbpSiteCategories, additionalGbpSiteCategories), add-ons (addOnIds), Google verification status (googleVerificationStatus), and client account scoping (clientIds).

Results are returned as a Relay-style connection (edges + pageInfo). Use the first/after (or last/before) parameters to page through results.

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/filter?input={%22tags%22%3A[%22priority%22]%2C%22city%22%3A[%22Austin%22]}&first=50&after=&last=&before=&archived=&approved=&hasErrors=&archivalScheduledAt=&blacklistIds=&sortByNameAsc=' \
--header 'Synup-Version: 2026-04-17' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200

application/json

Successful response

Bodyapplication/json

Example

{
    "data": {
        "filterLocations": {
            "edges": [
                {
                    "cursor": "string",
                    "node": null
                }
            ],
            "nodes": [
                null
            ],
            "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "totalPages": 0,
                "totalRecords": 0
            },
            "totalCount": 0
        }
    }
}

🟠400

🟠401

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

Download locations

Google verification location stats