브랜드 조회 | Listings API

이름	유형	필수	설명
brandId	string	필수	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

이름

유형

필수

설명

brandId

string

필수

Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

응답

200The brand.

Response

{  "data": {    "getSocialProfileDetails": {      "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "profileName": "Jenny Home",      "archived": false,      "logo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "profileLogo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "siteUrl": "https://jennyhome.example",      "countryIso": "US",      "bio": "Handmade furniture for real homes.",      "businessIntent": "A family-run home furnishings store selling handmade furniture and textiles.",      "categories": ["Furniture Store", "Home Goods"],      "brandHashtags": ["jennyhome", "handmadefurniture"],      "competitorHashtags": ["localfurniture"],      "connectedChannelCount": 3,      "timezone": {        "label": "(GMT-05:00) Eastern Time",        "tzCode": "America/New_York",        "name": "Eastern Standard Time",        "utc": "-05:00"      },      "contentPreferredLanguage": "en"    }  }}

401Unauthenticated, missing or invalid API key.

404No brand with that ID on this account (`SY95043`).

UUID로 단일 브랜드를 조회합니다. 응답 데이터는 GET /social/brands의 행 1개와 동일하므로, 이미 brandId를 가지고 있고 목록을 다시 조회하는 대신 최신 데이터를 가져오려는 경우에 사용합니다.

사용 사례: 게시 화면에 브랜드 헤더 표시. profileName과 logo를 읽어 작성기에 표시할 레이블을 지정하고, timezone.tzCode를 읽어 API가 실제로 예약 시간을 해석하는 시간대로 표시합니다. scheduleDate + scheduleTime으로 예약한 게시물의 시간은 이 필드를 기준으로 결정되므로, 사용자에게 다른 시간대를 표시하면 몇 시간씩 어긋나는 실수가 발생할 수 있습니다.

사용 사례: 게시 전 사전 점검. connectedChannelCount가 0이면 게시할 곳이 없습니다. SY95045로 거부될 게시물을 작성하도록 두는 대신 사용자를 연결 링크로 안내합니다.

참고 사항.

brandId는 일반 UUID입니다. 사업장 ID처럼 Base64로 인코딩하면 404가 발생합니다.
brandId는 경로 토큰으로만 사용됩니다. 요청 본문에서는 같은 값이 socialProfileId로 나타나며, 두 이름은 서로 다른 위치에서 사용되는 동일한 ID를 가리킵니다.
이미 보관된 브랜드의 경우 archived는 true입니다. 보관이 예약되기만 한 브랜드는 여전히 archived: false로 표시됩니다. 브랜드 보관을 참조합니다.
timezone.tzCode는 예약 시간을 해석하는 기준이 되는 IANA 식별자이며, 나머지 시간대 필드 3개는 표시용 레이블입니다.
브랜드의 개별 연결 정보인 플랫폼과 연결 ID를 조회하려면 GET /social/brands/{brandId}/connections를 호출합니다.

매개변수

경로

응답