Skip to content
SynupAPI
Get an API key
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

NameTypeRequiredDescription
locationIdstringrequiredRelay-encoded location ID.
bucketstringoptionalBucket to filter by (e.g. idea, calendar, series). Defaults to idea.
filterstringoptionalSource filter (e.g. ai or mine).
limitintegeroptionalMaximum number of ideas to return.
offsetintegeroptionalNumber of ideas to skip.

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI 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'

Responses

StatusDescription
200Successful response
401Unauthorized - 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

NameTypeRequiredDescription
dataobjectoptional
data.localPostIdeasarray of objectoptional
data.localPostIdeas[].idstringoptional
data.localPostIdeas[].locationIdintegeroptional
data.localPostIdeas[].titlestringoptional
data.localPostIdeas[].contentstringoptional
data.localPostIdeas[].imagePromptstringoptional
data.localPostIdeas[].imageUrlstringoptional
data.localPostIdeas[].typestringoptional
data.localPostIdeas[].statusstringoptional
data.localPostIdeas[].platformsarray of stringoptional
data.localPostIdeas[].bucketstringoptional
data.localPostIdeas[].calendarDayintegeroptional
data.localPostIdeas[].scheduledDatestringoptional
data.localPostIdeas[].scheduledTimestringoptional
data.localPostIdeas[].ctaTextstringoptional
data.localPostIdeas[].ctaUrlstringoptional
data.localPostIdeas[].notestringoptional
data.localPostIdeas[].seriesIdstringoptional
data.localPostIdeas[].localPostIdstringoptional
data.localPostIdeas[].isRecurringbooleanoptional
data.localPostIdeas[].isUserGeneratedbooleanoptional
data.localPostIdeas[].observanceNamestringoptional
data.localPostIdeas[].observanceDatestringoptional
data.localPostIdeas[].languagestringoptional
data.localPostIdeas[].generationBatchIdstringoptional
data.localPostIdeas[].createdAtstringoptional
data.localPostIdeas[].updatedAtstringoptional
data.localPostIdeas[].referenceImageOptionsarray of objectoptional
data.localPostIdeas[].referenceImageOptions[].urlstringoptional
data.localPostIdeas[].referenceImageOptions[].categorystringoptional
data.localPostIdeas[].generationStatestringoptional
data.localPostIdeas[].relevanceScorenumberoptional
data.localPostIdeas[].themestringoptional
data.localPostIdeas[].isRelevantbooleanoptional
data.localPostIdeas[].generationJobIdstringoptional