GETapi.synup.com/api/v4/local-post-ideas/extended-config
Local extended config
Returns the extended generation config for a location — brand tone, target customers, contact/address, brand colors and logos, and the services/products/content-rules used to ground post-idea generation.
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/extended-config?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/extended-config?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/extended-config?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/extended-config?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": {
"localExtendedConfig": {
"id": "string",
"locationId": 0,
"tone": "string",
"targetCustomers": "string",
"country": "string",
"phone": "string",
"address": "string",
"location": "string",
"primaryColor": "string",
"secondaryColor": "string",
"logoLight": "string",
"logoDark": "string",
"services": {},
"products": {},
"contentRules": {},
"additionalContext": "string",
"insights": {}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.localExtendedConfig | object | optional | |
data.localExtendedConfig.id | string | optional | |
data.localExtendedConfig.locationId | integer | optional | |
data.localExtendedConfig.tone | string | optional | |
data.localExtendedConfig.targetCustomers | string | optional | |
data.localExtendedConfig.country | string | optional | |
data.localExtendedConfig.phone | string | optional | |
data.localExtendedConfig.address | string | optional | |
data.localExtendedConfig.location | string | optional | |
data.localExtendedConfig.primaryColor | string | optional | |
data.localExtendedConfig.secondaryColor | string | optional | |
data.localExtendedConfig.logoLight | string | optional | |
data.localExtendedConfig.logoDark | string | optional | |
data.localExtendedConfig.services | object | optional | Free-form JSON describing services. |
data.localExtendedConfig.products | object | optional | Free-form JSON describing products. |
data.localExtendedConfig.contentRules | object | optional | Free-form JSON content rules. |
data.localExtendedConfig.additionalContext | string | optional | |
data.localExtendedConfig.insights | object | optional | Free-form JSON insights. |