GET/api/v4/social/brands/{brandId}/connections

List a brand's connections

Returns the social accounts connected to a brand, with the platform, display name and archival state of each.

Requires an API key. See Authentication for header format and key rotation.

Parameters

Path

NameTypeRequiredDescription
brandIdstringrequiredBrand UUID whose connections should be listed.

Responses

200The brand's connections.
Response
{  "data": {    "listConnectedChannelWithSocialProfile": {      "socialConnected": [        {          "id": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7",          "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "vendorProfileId": null,          "platform": "INSTAGRAM",          "displayName": "Jenny Home",          "userName": "jennyhome",          "userImage": "https://cdn.listingsapi.com/social/channels/b81d5b3c/avatar.jpg",          "archived": false,          "archivedAt": null,          "listingConnectedAccountId": null,          "referenceId": "17841400000000001"        },        {          "id": "2d4e6f80-1c33-4b7a-8e05-9a1b2c3d4e5f",          "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "vendorProfileId": null,          "platform": "FACEBOOK",          "displayName": "Jenny Home & Co.",          "userName": "jennyhomeco",          "userImage": "https://cdn.listingsapi.com/social/channels/2d4e6f80/avatar.jpg",          "archived": false,          "archivedAt": null,          "listingConnectedAccountId": "cf12de77-2211-4a09-b7c1-0a6f3b2e91aa",          "referenceId": "102938475601234"        }      ],      "profileCount": 1,      "channelCount": 2    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Lists the social accounts attached to one brand. Each row's id is the connection ID: the value you pass in connectedChannelIds when you want a post to go to specific channels, the value disconnect takes, and the socialConnectedChannelId that insights requires.

Use case: rendering the channel picker. Before showing a composer, read this list and offer one toggle per row, labelled with displayName and platform. A brand with an empty socialConnected array has nowhere to publish; send the user to a connection link instead.

Use case: confirming a connection landed. After the user returns from the hosted connection flow with status=success, poll this endpoint until the row whose id matches the connectedAccountId on the return URL appears. Connections are materialised asynchronously, so allow a few seconds and a couple of retries before showing an error.

Notes.

  • platform is one of FACEBOOK, INSTAGRAM, TWITTER (X), LINKEDIN, PINTEREST.
  • id is Synup's connection UUID, and the value every Social endpoint that takes a connection wants. referenceId is the platform's own account identifier — a Facebook Page ID, an Instagram business account ID — useful for matching against records you hold outside Synup, but never accepted as input here.
  • archived: true with an archivedAt timestamp means the connection is gone, either because someone disconnected it, because the brand was archived, or because the platform revoked the token. A post targeting an archived channel fails with SY95045.
  • listingConnectedAccountId is set only when the same account is also linked on the Listings side; it is null for a Social-only connection.
  • Only one connection per platform per brand is used for publishing. Connecting the same platform again on the same brand replaces the previous channel rather than adding a second one.
  • To see your account-wide connection usage against your cap rather than one brand's channels, call GET /social/limits.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"