Synupv1
Criar chave
v1Recursos/Locations/getListar / buscar locais

Listar / buscar locais

Retorna uma página de locais, os mais recentes primeiro. Todos os filtros são opcionais e se combinam (um local precisa corresponder a todos); para avançar para mais resultados, envie novamente o nextCursor retornado.

get/api/v1/locations
locations:read
Parâmetros de consulta
clientIdstringopcional
Restringe os resultados a um cliente. Quando sua chave está limitada a clientes específicos, este deve ser um deles. Procure com GET /api/v1/clients.
searchstringopcional
Busca por texto livre no nome, endereço, cidade ou telefone do local (sem diferenciar maiúsculas/minúsculas, correspondências parciais permitidas).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)opcional
Um único grupo de status: all, active (não arquivado), archived, archival_pending, verification_pending (aprovação do Google pendente), unapproved ou requires_action. O padrão é all.
tagsarray of stringopcional
Tags internas — corresponde a um local que tenha qualquer uma destas.
categoriesarray of stringopcional
Nomes de exibição de categoria — corresponde a um local cuja categoria geral ou do Google seja qualquer uma destas.
verificationarray of string (verified | pending | unverified | unknown)opcional
Estado de verificação do Google: verified, pending, unverified ou unknown.
createdAfterstringopcional
Somente locais criados nesta data ou depois.
createdBeforestringopcional
Somente locais criados nesta data ou antes.
cursorstringopcional
Cursor de paginação do nextCursor de uma resposta anterior. Deixe vazio para a primeira página.
limitintegeropcional
Locais a retornar por página, 1–200. O padrão é 50.
Resposta
dataobjectopcional
locationsarray of objectopcional
Os locais correspondentes para esta página.
idstringopcional
Identificador único do local.
namestringopcional
O nome comercial do local.
addressstringopcional
O endereço do local (linhas de rua combinadas), ou null.
citystringopcional
Cidade.
statestringopcional
Estado ou região.
postalCodestringopcional
CEP ou código postal, ou null.
countrystringopcional
País, como código ISO-3166-1 alfa-2, ou null.
phonestringopcional
Número de telefone principal, ou null.
websitestringopcional
A URL do site do local, ou null.
storeCodestringopcional
Seu código interno de loja / referência para este local, ou null.
categorystringopcional
A categoria de exibição do local (categoria primária por publisher, se definida, senão a categoria geral), ou null.
tagsarray of stringopcional
Tags internas para organização própria — não exibidas publicamente.
labelsarray of stringopcional
Etiquetas internas para este local.
statusstring (active | archived | archival_pending | verification_pending | unapproved | requires_action)opcional
Status derivado: active, archived, archival_pending, verification_pending (aprovação do Google pendente), unapproved ou requires_action.
verificationStatusstring (verified | pending | unverified | unknown)opcional
Estado de verificação do Google: verified, pending, unverified ou unknown, ou null.
pendingChangesnumberopcional
Número de edições salvas na fila para publicação, mas ainda não sincronizadas com os diretórios conectados.
lastPublishedAtstringopcional
Quando os detalhes deste local foram sincronizados com sucesso pela última vez com um publisher, como timestamp ISO 8601, ou null.
clientIdstringopcional
ID do cliente ao qual este local pertence, ou null.
clientNamestringopcional
Nome comercial do cliente ao qual este local pertence, ou null.
createdAtstringopcional
Data de criação do local, como timestamp ISO 8601.
nextCursorstringopcional
Cursor de paginação para a próxima página, ou null quando não há mais resultados.
totalnumberopcional
Número total de locais que correspondem aos filtros, em todas as páginas.
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/locations
Sua chave 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"
    }
  ]
}