GETapi.synup.com/api/v4/local-post-ideas/post-ideas
Local post ideas
Returns the AI post ideas for a location. Filter by bucket (e.g. idea, calendar, series) and filter (e.g. ai vs mine), and page with limit/offset.
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. |
bucket | string | optional | Bucket to filter by (e.g. idea, calendar, series). Defaults to idea. |
filter | string | optional | Source filter (e.g. ai or mine). |
limit | integer | optional | Maximum number of ideas to return. |
offset | integer | optional | Number of ideas to skip. |
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/post-ideas?locationId=&bucket=&filter=&limit=&offset=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/post-ideas?locationId=&bucket=&filter=&limit=&offset=', {
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/post-ideas?locationId=&bucket=&filter=&limit=&offset=",
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/post-ideas?locationId=&bucket=&filter=&limit=&offset=", 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": {
"localPostIdeas": [
{
"id": "string",
"locationId": 0,
"title": "string",
"content": "string",
"imagePrompt": "string",
"imageUrl": "string",
"type": "string",
"status": "string",
"platforms": [
"string"
],
"bucket": "string",
"calendarDay": 0,
"scheduledDate": "string",
"scheduledTime": "string",
"ctaText": "string",
"ctaUrl": "string",
"note": "string",
"seriesId": "string",
"localPostId": "string",
"isRecurring": true,
"isUserGenerated": true,
"observanceName": "string",
"observanceDate": "string",
"language": "string",
"generationBatchId": "string",
"createdAt": "string",
"updatedAt": "string",
"referenceImageOptions": [
{
"url": "string",
"category": "string"
}
],
"generationState": "string",
"relevanceScore": 0,
"theme": "string",
"isRelevant": true,
"generationJobId": "string"
}
]
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.localPostIdeas | array of object | optional | |
data.localPostIdeas[].id | string | optional | |
data.localPostIdeas[].locationId | integer | optional | |
data.localPostIdeas[].title | string | optional | |
data.localPostIdeas[].content | string | optional | |
data.localPostIdeas[].imagePrompt | string | optional | |
data.localPostIdeas[].imageUrl | string | optional | |
data.localPostIdeas[].type | string | optional | |
data.localPostIdeas[].status | string | optional | |
data.localPostIdeas[].platforms | array of string | optional | |
data.localPostIdeas[].bucket | string | optional | |
data.localPostIdeas[].calendarDay | integer | optional | |
data.localPostIdeas[].scheduledDate | string | optional | |
data.localPostIdeas[].scheduledTime | string | optional | |
data.localPostIdeas[].ctaText | string | optional | |
data.localPostIdeas[].ctaUrl | string | optional | |
data.localPostIdeas[].note | string | optional | |
data.localPostIdeas[].seriesId | string | optional | |
data.localPostIdeas[].localPostId | string | optional | |
data.localPostIdeas[].isRecurring | boolean | optional | |
data.localPostIdeas[].isUserGenerated | boolean | optional | |
data.localPostIdeas[].observanceName | string | optional | |
data.localPostIdeas[].observanceDate | string | optional | |
data.localPostIdeas[].language | string | optional | |
data.localPostIdeas[].generationBatchId | string | optional | |
data.localPostIdeas[].createdAt | string | optional | |
data.localPostIdeas[].updatedAt | string | optional | |
data.localPostIdeas[].referenceImageOptions | array of object | optional | |
data.localPostIdeas[].referenceImageOptions[].url | string | optional | |
data.localPostIdeas[].referenceImageOptions[].category | string | optional | |
data.localPostIdeas[].generationState | string | optional | |
data.localPostIdeas[].relevanceScore | number | optional | |
data.localPostIdeas[].theme | string | optional | |
data.localPostIdeas[].isRelevant | boolean | optional | |
data.localPostIdeas[].generationJobId | string | optional |