GETapi.synup.com/api/v4/locations/{locationId}/keywords

List Keywords

This API retrieves all keywords associated with a specific location.

Behavior:

Returns a complete list of keywords linked to the location.
Includes unique keyword IDs and names.

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

Parameters

Path

Name	Type	Required	Description
`locationId`	string	required	Base64 encoded ID of the location to fetch keywords for

Request

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

const res = await fetch('https://api.synup.com/api/v4/locations/:locationId/keywords', {
  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/:locationId/keywords",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/:locationId/keywords", 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`	Successfully retrieved keywords
`400`	Invalid location ID
`401`	Unauthorized access

Example response (generated from the schema)

{
  "data": {
    "keywordsByLocationId": [
      {
        "id": "S2V5d29yZDoxOTM2ODAx",
        "name": "road paving"
      }
    ]
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.keywordsByLocationId`	array of object	optional	List of keywords associated with the location. Returns empty array if no keywords exist.
`data.keywordsByLocationId[].id`	string	required	The unique ID attached to the keyword
`data.keywordsByLocationId[].name`	string	required	The text value of the keyword