GET/api/v4/connected-accounts/{connectedAccountId}/connection-suggestions

Listar sugerencias de conexión

Devuelve coincidencias sugeridas entre ubicaciones de Listings API y fichas de Google Business Profile o Facebook para una cuenta conectada.

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
connectedAccountIdstringobligatorioUUID of the connected account to list suggestions for.

Consulta

NombreTipoObligatorioDescripciónPredeterminado
pageintegeropcional1-based page number.1
perPageintegeropcionalRecords per page.20

Respuestas

200Paginated list of connection suggestions.
Response
{  "data": {    "connectionSuggestionsForAccount": {      "pageInfo": {        "hasNextPage": false,        "hasPreviousPage": false,        "totalPages": 1,        "totalRecords": 2      },      "records": [        {          "accountEmail": "contact@brightsmile-dental.com",          "accountType": "GMB",          "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",          "locationId": "73415",          "matchedDataDatabaseId": "0d5e306f-0da0-46e3-929f-fd3c67ccd8cc",          "locationInfo": {            "name": "My Business",            "city": "Lincoln",            "stateIso": "NE"          },          "suggestedLocationInfo": {            "locationInfo": { "name": "My Business", "city": "Lincoln" }          }        }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Devuelve emparejamientos sugeridos entre ubicaciones de Listings API y fichas de Google Business Profile o Facebook detectados al ejecutar los activadores de coincidencias en la cuenta conectada. Cada registro muestra tanto los detalles de la ubicación de Listings API como la ficha coincidente de la plataforma de publicación para que un operador pueda compararlos antes de confirmar.

Las sugerencias se generan de forma asíncrona mediante POST /connected-accounts/trigger-matches. Si acabas de conectar una cuenta, llama primero a trigger-matches; de lo contrario, records está vacío y pageInfo.totalRecords es 0. (Al ejecutarse en un entorno real con una cuenta recién conectada que aún no tiene coincidencias, este endpoint devuelve {"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}}.) El ejemplo anterior muestra la estructura de un registro con datos.

Caso de uso: flujo de trabajo de revisión previa a la confirmación. Después de importar la cuenta de Google de un cliente, consulta periódicamente este endpoint para mostrar cada coincidencia sugerida en tu propia interfaz de revisión. Un operador aprueba los emparejamientos correctos y tú pasas los ID de los registros aprobados a POST /connected-accounts/confirm-matches.

Identificación de un registro. Un registro de sugerencia no tiene un campo id. Su identificador es matchedDataDatabaseId, la clave primaria del registro de coincidencia subyacente; accountType te indica de qué tipo de registro de coincidencia se trata (GMB, FB o APPLE). Confirmar coincidencias necesita ambos valores para construir el id que acepta, así que mantén ambos juntos cuando prepares las sugerencias para su revisión.

Paginación y límites de solicitudes. Pagina con los parámetros de consulta de primer nivel page y perPage (por ejemplo, ?page=2&perPage=50) y comprueba pageInfo.hasNextPage. No hay ningún parámetro pageInfo, filters, sortBy ni accountId: la cuenta conectada se obtiene de la ruta, el orden es fijo y ascendente según la información de la ubicación, y cualquier otro parámetro que envíes se ignora en lugar de rechazarse. Este endpoint tiene un límite de solicitudes, al igual que otros endpoints de listado; si recibes un 429, reduce la frecuencia de las consultas y vuelve a intentarlo una vez transcurrido el tiempo indicado por el valor de la cabecera Retry-After, en lugar de acortar el intervalo entre consultas.

Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \  -H "Authorization: API $LISTINGSAPI_KEY"