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

Available search filter values

Returns the distinct values available for the standard location filters across the account's accessible locations: tags, folders, categories, additional categories, and Google Business Profile (GBP) categories (primary and additional). Use these values to populate the 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/search-filters' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/locations/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/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/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": {
    "searchFilters": {
      "tags": [
        "string"
      ],
      "folders": [
        "string"
      ],
      "categories": [
        "string"
      ],
      "additionalCategories": [
        "string"
      ],
      "primaryGbpSiteCategories": [
        {
          "name": "string",
          "value": 0,
          "id": "string"
        }
      ],
      "additionalGbpSiteCategories": [
        {
          "name": "string",
          "value": 0,
          "id": "string"
        }
      ]
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.searchFilters`	object	optional
`data.searchFilters.tags`	array of string	optional
`data.searchFilters.folders`	array of string	optional
`data.searchFilters.categories`	array of string	optional
`data.searchFilters.additionalCategories`	array of string	optional
`data.searchFilters.primaryGbpSiteCategories`	array of object	optional
`data.searchFilters.primaryGbpSiteCategories[].name`	string	optional	Name of the category.
`data.searchFilters.primaryGbpSiteCategories[].value`	integer	optional	Internal numeric identifier of the category.
`data.searchFilters.primaryGbpSiteCategories[].id`	string	optional	GBP site category identifier.
`data.searchFilters.additionalGbpSiteCategories`	array of object	optional
`data.searchFilters.additionalGbpSiteCategories[].name`	string	optional	Name of the category.
`data.searchFilters.additionalGbpSiteCategories[].value`	integer	optional	Internal numeric identifier of the category.
`data.searchFilters.additionalGbpSiteCategories[].id`	string	optional	GBP site category identifier.