Synup
Create a key
v1Resources/Social Listening/getGet a client's listening setup

Get a client's listening setup

Returns what a client tracks in social listening — its topics and competitors — and when results next update. Results update once a month.

get/api/v1/listening/setup
listening:read
Query parameters
clientIdstringrequired
The client (business) this concerns. Required.
Response
dataobjectoptional
clientobjectoptional
The client: id and name.
topicsarray of objectoptional
The client's topics, including suggestions that are not turned on yet.
competitorsarray of objectoptional
The competitors the client tracks.
scheduleobjectoptional
How often results update (monthly) and when the next update is due.
topicKindsarray of stringoptional
The topic kinds a topic can have.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/listening/setup
Your API key
clientId *
{
  "data": {
    "client": {
      "id": "cli_123",
      "name": "Acme Dental"
    },
    "topics": [
      {
        "id": "top_123",
        "name": "Acme Dental",
        "kind": "brand",
        "status": "active",
        "sources": [
          "x",
          "reddit"
        ],
        "languages": []
      }
    ],
    "competitors": [
      {
        "id": "cmp_123",
        "name": "Bright Smiles",
        "aliases": [],
        "handles": {
          "x": [
            "brightsmiles"
          ]
        },
        "website": null,
        "status": "active"
      }
    ],
    "schedule": {
      "frequency": "monthly",
      "nextUpdate": "2026-11-01T00:00:00.000Z"
    },
    "topicKinds": [
      "brand",
      "competitor",
      "product",
      "industry",
      "campaign",
      "custom"
    ]
  }
}

New to the Synup API?