GETapi.synup.com/api/v4/locations/advanced-search-filters

Available advanced filter values

Returns the distinct values available for the advanced location filters across the account's locations: countries, states, cities, postal (zip) codes, and custom attribute names. Use these values to populate the advanced filter controls before calling Filter locations.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Request

curl -X GET 'https://api.synup.com/api/v4/locations/advanced-search-filters' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/locations/advanced-search-filters', {
  method: 'GET',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});
const data = await res.json();

import requests
res = requests.get(
    "https://api.synup.com/api/v4/locations/advanced-search-filters",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/advanced-search-filters", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successful response
`401`	Unauthorized - Invalid or missing API key

Example response (generated from the schema)

{
  "data": {
    "advancedSearchFilters": {
      "country": [
        {}
      ],
      "state": [
        {}
      ],
      "city": [
        "string"
      ],
      "zipcode": [
        "string"
      ],
      "customAttrs": [
        "string"
      ]
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.advancedSearchFilters`	object	optional
`data.advancedSearchFilters.country`	array of object	optional	Countries present across the account's locations.
`data.advancedSearchFilters.state`	array of object	optional	States present across the account's locations.
`data.advancedSearchFilters.city`	array of string	optional
`data.advancedSearchFilters.zipcode`	array of string	optional
`data.advancedSearchFilters.customAttrs`	array of string	optional	Custom attribute names defined for the account.