GETapi.synup.com/api/v4/local-post-ideas/location-info
Local location info
Returns the basic location profile used by post-idea generation — name, site URL, categories, and contact/address details.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | required | Relay-encoded location ID. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Synup-Version | string | required | API version date (YYYY-MM-DD). |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/location-info?locationId=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/location-info?locationId=', {
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/local-post-ideas/location-info?locationId=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/local-post-ideas/location-info?locationId=", 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": {
"localLocationInfo": {
"id": "string",
"name": "string",
"siteUrl": "string",
"primaryCategory": "string",
"categories": [
"string"
],
"country": "string",
"phone": "string",
"address": "string",
"city": "string",
"state": "string"
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.localLocationInfo | object | optional | |
data.localLocationInfo.id | string | optional | |
data.localLocationInfo.name | string | optional | |
data.localLocationInfo.siteUrl | string | optional | |
data.localLocationInfo.primaryCategory | string | optional | |
data.localLocationInfo.categories | array of string | optional | |
data.localLocationInfo.country | string | optional | |
data.localLocationInfo.phone | string | optional | |
data.localLocationInfo.address | string | optional | |
data.localLocationInfo.city | string | optional | |
data.localLocationInfo.state | string | optional |