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

Obtenir une marque

Renvoie une marque sur les réseaux sociaux avec les détails de son profil, son fuseau horaire, son état d’archivage et le nombre de canaux connectés.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Chemin

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

Réponses

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

Récupère une seule marque à partir de son UUID. Le contenu renvoyé est identique à une ligne de GET /social/brands ; utilisez donc cette opération lorsque vous disposez déjà d’un brandId et souhaitez obtenir la version la plus récente plutôt que de récupérer à nouveau la liste.

Cas d’utilisation : afficher l’en-tête de la marque sur un écran de publication. Lisez profileName et logo pour identifier la marque dans l’éditeur de publication, et timezone.tzCode pour afficher les heures programmées dans le fuseau horaire dans lequel l’API les interprétera réellement. Une publication programmée avec scheduleDate + scheduleTime utilise le fuseau horaire de ce champ ; afficher un autre fuseau horaire risque donc d’entraîner des erreurs de décalage de plusieurs heures.

Cas d’utilisation : vérification préalable à la publication. Si connectedChannelCount vaut 0, aucun canal n’est disponible pour publier. Orientez l’utilisateur vers un lien de connexion au lieu de le laisser rédiger une publication qui sera rejetée avec SY95045.

Remarques.

  • brandId est un UUID simple. L’encoder en Base64, comme vous le feriez pour un identifiant d’établissement, produit une erreur 404.
  • brandId est uniquement un paramètre de chemin. La même valeur apparaît dans les corps des requêtes sous le nom socialProfileId ; les deux noms désignent le même identifiant à des emplacements différents.
  • archived vaut true pour une marque déjà archivée. Pour une marque dont l’archivage est simplement programmé, la valeur reste archived: false — consultez archiver une marque.
  • timezone.tzCode est l’identifiant IANA utilisé pour interpréter les horaires programmés ; les trois autres champs de fuseau horaire sont des libellés d’affichage.
  • Pour obtenir les connexions individuelles de la marque — leurs plateformes et leurs identifiants de connexion — appelez GET /social/brands/{brandId}/connections.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>' \  -H "Authorization: API $LISTINGSAPI_KEY"