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

Listar las conexiones de una marca

Devuelve las cuentas de redes sociales conectadas a una marca, con la plataforma, el nombre para mostrar y el estado de archivado de cada una.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Ruta

NombreTipoObligatorioDescripción
brandIdstringobligatorioBrand UUID whose connections should be listed.

Respuestas

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

Lista las cuentas de redes sociales vinculadas a una marca. El id de cada fila es el ID de conexión: el valor que pasas en connectedChannelIds cuando quieres que una publicación se envíe a canales específicos, el valor que acepta desconectar y el socialConnectedChannelId que requiere estadísticas.

Caso de uso: mostrar el selector de canales. Antes de mostrar un editor de publicaciones, consulta esta lista y ofrece un interruptor por fila, etiquetado con displayName y platform. Una marca con un array socialConnected vacío no tiene dónde publicar; dirige al usuario a un enlace de conexión en su lugar.

Caso de uso: confirmar que se ha establecido una conexión. Después de que el usuario regrese del flujo de conexión alojado con status=success, consulta periódicamente este endpoint hasta que aparezca la fila cuyo id coincida con el connectedAccountId de la URL de retorno. Las conexiones se materializan de forma asíncrona, así que espera unos segundos y realiza un par de reintentos antes de mostrar un error.

Notas.

  • platform es uno de los siguientes valores: FACEBOOK, INSTAGRAM, TWITTER (X), LINKEDIN, PINTEREST.
  • id es el UUID de la conexión y el valor que espera cualquier endpoint de Social que acepte una conexión. referenceId es el identificador de cuenta propio de la plataforma —un ID de página de Facebook o un ID de cuenta de empresa de Instagram—, útil para cotejarlo con los registros que mantienes fuera de ListingsAPI, pero nunca se acepta como entrada aquí.
  • archived: true con una marca de tiempo archivedAt significa que la conexión ya no existe, ya sea porque alguien la desconectó, porque se archivó la marca o porque la plataforma revocó el token. Una publicación destinada a un canal archivado falla con SY95045.
  • listingConnectedAccountId solo se establece cuando la misma cuenta también está vinculada en Listings; su valor es null para una conexión exclusiva de Social.
  • Solo se utiliza una conexión por plataforma y por marca para publicar. Volver a conectar la misma plataforma a la misma marca sustituye el canal anterior en lugar de añadir un segundo canal.
  • Para consultar el uso de conexiones en toda tu cuenta en relación con tu límite, en lugar de los canales de una marca, llama a GET /social/limits.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"