Synupv1
Crear clave
v1Recursos/Locations/getListar / buscar ubicaciones

Listar / buscar ubicaciones

Devuelve una página de ubicaciones, empezando por las más recientes. Todos los filtros son opcionales y se combinan (una ubicación debe cumplir con todos ellos); para avanzar a más resultados, vuelva a enviar el nextCursor devuelto.

get/api/v1/locations
locations:read
Parámetros de consulta
clientIdstringopcional
Restringe los resultados a un cliente. Si su clave está limitada a clientes específicos, debe ser uno de ellos. Búsquelo con GET /api/v1/clients.
searchstringopcional
Búsqueda de texto libre sobre el nombre, la dirección postal, la ciudad o el teléfono de la ubicación (sin distinguir mayúsculas, coincidencias parciales permitidas).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)opcional
Un único grupo de estado: all, active (no archivada), archived, archival_pending, verification_pending (aprobación de Google pendiente), unapproved o requires_action. El valor por defecto es all.
tagsarray of stringopcional
Etiquetas internas — coincide con una ubicación que tenga alguna de estas.
categoriesarray of stringopcional
Nombres visibles de categoría — coincide con una ubicación cuya categoría general o de Google sea alguna de estas.
verificationarray of string (verified | pending | unverified | unknown)opcional
Estado de verificación de Google: verified, pending, unverified o unknown.
createdAfterstringopcional
Solo ubicaciones creadas en esta fecha o después.
createdBeforestringopcional
Solo ubicaciones creadas en esta fecha o antes.
cursorstringopcional
Cursor de paginación del nextCursor de una respuesta anterior. Déjelo vacío para la primera página.
limitintegeropcional
Ubicaciones a devolver por página, 1–200. El valor por defecto es 50.
Respuesta
dataobjectopcional
locationsarray of objectopcional
Las ubicaciones que coinciden en esta página.
idstringopcional
Identificador único de la ubicación.
namestringopcional
El nombre comercial de la ubicación.
addressstringopcional
La dirección postal de la ubicación (líneas de calle combinadas), o null.
citystringopcional
Ciudad.
statestringopcional
Estado o región.
postalCodestringopcional
Código postal, o null.
countrystringopcional
País, como código ISO-3166-1 alfa-2, o null.
phonestringopcional
Número de teléfono principal, o null.
websitestringopcional
La URL del sitio web de la ubicación, o null.
storeCodestringopcional
Su código o referencia interna de tienda para esta ubicación, o null.
categorystringopcional
La categoría visible de la ubicación (la categoría principal por publisher si está establecida, si no, la categoría general), o null.
tagsarray of stringopcional
Etiquetas internas para su propia organización — no se muestran públicamente.
labelsarray of stringopcional
Rótulos internos para esta ubicación.
statusstring (active | archived | archival_pending | verification_pending | unapproved | requires_action)opcional
Estado derivado: active, archived, archival_pending, verification_pending (aprobación de Google pendiente), unapproved o requires_action.
verificationStatusstring (verified | pending | unverified | unknown)opcional
Estado de verificación de Google: verified, pending, unverified o unknown, o null.
pendingChangesnumberopcional
Número de ediciones guardadas en cola para publicarse pero aún no sincronizadas con los directorios conectados.
lastPublishedAtstringopcional
Fecha de la última sincronización correcta de los datos de esta ubicación con un publisher, como marca de tiempo ISO 8601, o null.
clientIdstringopcional
ID del cliente al que pertenece esta ubicación, o null.
clientNamestringopcional
Nombre comercial del cliente al que pertenece esta ubicación, o null.
createdAtstringopcional
Fecha de creación de la ubicación, como marca de tiempo ISO 8601.
nextCursorstringopcional
Cursor de paginación para la siguiente página, o null cuando no hay más resultados.
totalnumberopcional
Número total de ubicaciones que coinciden con los filtros, en todas las páginas.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/locations
Su clave de API
clientId
search
status
tags
categories
verification
createdAfter
createdBefore
cursor
limit
{
  "data": [
    {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123",
      "createdAt": "2026-01-15T10:05:00.000Z"
    }
  ]
}