Listings APIListings API
Iniciar sesión
POST/api/v4/connected-accounts/connected-account-listings

Obtener las fichas de una cuenta conectada

Devuelve las fichas de Google Business Profile o Facebook a las que tiene acceso una cuenta conectada, con filtrado y paginación opcionales.

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

Parámetros

Cuerpo

NombreTipoObligatorioDescripción
connectedAccountIdstringobligatorioUUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored.
pageintegeropcionalPage number to fetch. Defaults to 1.
perPageintegeropcionalRecords per page. Defaults to 500, which is also the maximum.
locationInfostringopcionalFree-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone.

Solicitud de ejemplo

Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.

Request body
{  "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",  "perPage": 50}

Respuestas

200List of listings accessible to the account, with pagination metadata.
Response
{  "data": {    "connectedAccountListings": {      "pageInfo": {        "hasNextPage": false,        "hasPreviousPage": false,        "totalPages": 1,        "totalRecords": 60      },      "records": [        {          "accountTypeName": "Google",          "address": "123 William St, NY 10038, Manhattan, US",          "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==",          "liveLink": null,          "locationName": "Trial",          "phone": "(718) 667-7787"        }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Devuelve las fichas de Google Business Profile o Facebook a las que tiene acceso una cuenta conectada. Cada registro incluye el id de la ficha (un ID en base64), locationName, address, phone y liveLink. Aunque se utiliza POST, se trata de una operación de lectura, pero las opciones de cuenta y paginación deben enviarse en el cuerpo JSON.

Caso de uso: crear un selector de fichas. Después de que un cliente conecte una cuenta de Google que sea propietaria de decenas de fichas, llama a este endpoint para mostrar una lista con función de búsqueda. Introduce un término de búsqueda escrito por el cliente en locationInfo (busca coincidencias en el nombre, la dirección, el teléfono, el código postal y el código de tienda) para que pueda encontrar rápidamente el establecimiento correcto.

Caso de uso: proporcionar datos a connect-listing. El id de cada registro es exactamente el connectedAccountListingId que espera connect-listing. Obtén las fichas, deja que el cliente (o tu lógica de coincidencia) elija una y, a continuación, pasa su id junto con el locationId de destino de Listings API a connect-listing para vincularlos.

Pagina con las claves page y perPage directamente en el cuerpo; perPage tiene un valor predeterminado de 500, que también es el máximo. Lee pageInfo.hasNextPage y pageInfo.totalPages de la respuesta para recorrer todas las páginas del conjunto completo. Este endpoint cuenta para el límite de solicitudes de la cuenta; una respuesta 429 incluye una cabecera Retry-After.

La estructura de la solicitud anterior se ha verificado con la API en funcionamiento. La respuesta de ejemplo es ilustrativa.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",    "perPage": 50  }'
Run in playground