Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/local-post-ideas/chat-sessions

Local chat sessions

Returns the AI post-idea chat sessions for a location, most recent first. Use limit to cap the number of sessions returned.

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

Parameters

Query

NameTypeRequiredDescription
locationIdstringrequiredRelay-encoded location ID.
limitintegeroptionalMaximum number of sessions to return.

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Request

Request
curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/chat-sessions?locationId=&limit=' \
  -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": {
    "localChatSessions": [
      {
        "id": "string",
        "locationId": 0,
        "mode": "string",
        "status": "string",
        "messageCount": 0,
        "title": "string",
        "subjectType": "string",
        "subjectId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.localChatSessionsarray of objectoptional
data.localChatSessions[].idstringoptional
data.localChatSessions[].locationIdintegeroptional
data.localChatSessions[].modestringoptional
data.localChatSessions[].statusstringoptional
data.localChatSessions[].messageCountintegeroptional
data.localChatSessions[].titlestringoptional
data.localChatSessions[].subjectTypestringoptional
data.localChatSessions[].subjectIdstringoptional
data.localChatSessions[].createdAtstringoptional
data.localChatSessions[].updatedAtstringoptional