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

브랜드의 연결 목록 조회

브랜드에 연결된 소셜 계정을 각 계정의 플랫폼, 표시 이름 및 보관 상태와 함께 반환합니다.

API 키가 필요합니다. 헤더 형식과 키 교체는 인증을 참고하세요.

매개변수

경로

이름유형필수설명
brandIdstring필수Brand UUID whose connections should be listed.

응답

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`).

한 브랜드에 연결된 소셜 계정 목록을 조회합니다. 각 행의 id는 연결 ID입니다. 이 값은 게시물을 특정 채널에 게시하려 할 때 connectedChannelIds에 전달하는 값이자, 연결 해제가 받는 값이며, 인사이트에 필요한 socialConnectedChannelId입니다.

사용 사례: 채널 선택기 표시. 게시물 작성 화면을 표시하기 전에 이 목록을 조회하고, 각 행마다 displayName 및 platform을 레이블로 사용하는 토글을 제공합니다. socialConnected 배열이 비어 있는 브랜드는 게시할 곳이 없으므로, 대신 사용자를 연결 링크로 안내합니다.

사용 사례: 연결이 반영되었는지 확인. 사용자가 호스팅된 연결 절차를 마치고 status=success와 함께 돌아오면, id가 반환 URL의 connectedAccountId와 일치하는 행이 나타날 때까지 이 엔드포인트를 폴링합니다. 연결은 비동기적으로 생성되므로, 오류를 표시하기 전에 몇 초간 기다리고 두어 번 재시도합니다.

참고 사항.

  • platform은 FACEBOOK, INSTAGRAM, TWITTER(X), LINKEDIN, PINTEREST 중 하나입니다.
  • id는 연결의 UUID이며, 연결을 입력으로 받는 모든 Social 엔드포인트에서 요구하는 값입니다. referenceId는 Facebook Page ID나 Instagram 비즈니스 계정 ID와 같은 플랫폼 자체의 계정 식별자로, ListingsAPI 외부에 보유한 레코드와 대조하는 데 유용하지만 여기서는 입력값으로 받지 않습니다.
  • archivedAt 타임스탬프가 있는 archived: true는 누군가 해당 연결을 해제했거나, 브랜드가 보관되었거나, 플랫폼이 토큰을 취소하여 연결이 사라졌음을 의미합니다. 보관된 채널을 대상으로 하는 게시물은 SY95045 오류로 실패합니다.
  • listingConnectedAccountId는 동일한 계정이 Listings 측에도 연결된 경우에만 설정되며, Social에만 연결된 경우에는 null입니다.
  • 게시에는 브랜드별로 플랫폼당 하나의 연결만 사용됩니다. 동일한 브랜드에 동일한 플랫폼을 다시 연결하면 두 번째 채널이 추가되는 대신 이전 채널이 교체됩니다.
  • 한 브랜드의 채널이 아니라 계정 전체의 한도 대비 연결 사용량을 확인하려면 GET /social/limits를 호출합니다.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"