GETapi.synup.com/api/v4/social-post-ideas/chat-sessions

Chat sessions

Returns the AI post-idea chat sessions for a brand (social profile), 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

Name	Type	Required	Description
`socialProfileId`	string	required	Social profile ID.
`limit`	integer	optional	Maximum number of sessions to return.

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Request

curl -X GET 'https://api.synup.com/api/v4/social-post-ideas/chat-sessions?socialProfileId=&limit=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/social-post-ideas/chat-sessions?socialProfileId=&limit=', {
  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/social-post-ideas/chat-sessions?socialProfileId=&limit=",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/social-post-ideas/chat-sessions?socialProfileId=&limit=", 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": {
    "chatSessions": [
      {
        "id": "string",
        "socialProfileId": "string",
        "mode": "string",
        "status": "string",
        "messageCount": 0,
        "title": "string",
        "createdAt": "string"
      }
    ]
  }
}

Response body

Name	Type	Required
`data`	object	optional
`data.chatSessions`	array of object	optional
`data.chatSessions[].id`	string	optional
`data.chatSessions[].socialProfileId`	string	optional
`data.chatSessions[].mode`	string	optional
`data.chatSessions[].status`	string	optional
`data.chatSessions[].messageCount`	integer	optional
`data.chatSessions[].title`	string	optional
`data.chatSessions[].createdAt`	string	optional