GET/api/v4/locations-by-ids

Obter locais por IDs

Retorna informações completas dos locais para um conjunto especificado de IDs de locais em uma única requisição.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Query

NomeTipoObrigatórioDescriçãoPadrão
idsstringobrigatórioJSON-encoded array of base64 location IDs, e.g. `["TG9jYXRpb246MTgwMDI4OQ=="]`. URL-encode the value.—

Respostas

200Array of full location objects, one per resolved ID. Unknown IDs are omitted.
Response
{  "data": {    "getLocationsByIds": [      {        "id": "TG9jYXRpb246MTgwMDI4OQ==",        "databaseId": 1800289,        "accountId": 12345,        "storeId": null,        "name": "Jenny Home",        "archived": false,        "archivedAt": null,        "street": "600 Congress Ave, Suite 200",        "city": "Austin",        "stateIso": "TX",        "postalCode": "78701",        "countryIso": "US",        "countryCode": "1",        "latitude": "30.2711286",        "longitude": "-97.7436995",        "phone": "5125550142",        "additionalPhones": [],        "bizUrl": null,        "hideAddress": false,        "categoryId": 15,        "subCategoryId": 1432,        "subCategoryName": "Restaurants",        "additionalCategoryIds": [],        "description": "This is a standalone duplex house. A comfortable, private residence located in the Bouldin Creek neighborhood of Austin, offering spacious duplex living with easy access to the surrounding South Congress area and downtown Austin.",        "contentPreferredLanguage": "ENGLISH",        "businessHours": [],        "moreHours": [],        "package": "PREMIUM",        "planId": 3797,        "planName": "Launch",        "temporarilyClosed": false,        "ownerName": null,        "ownerEmail": null,        "paymentMethods": [],        "locationPhotos": [],        "isRestaurant": true,        "voiceStatus": 3,        "yearOfIncorporation": null,        "placeActionLinks": [          {            "placeActionType": "FOOD_ORDERING",            "uri": "https://order.example.com",            "isPreferred": true,            "name": "locations/1944.../placeActionLinks/54ada85bc246058a",            "submissionStatus": "success",            "submissionMessage": "Already up to date on Google.",            "lastSubmittedAt": "2026-07-08T12:14:36Z"          }        ],        "discoveredPlaceActionLinks": [          {            "placeActionType": "APPOINTMENT",            "uri": "https://book.example.com",            "isPreferred": false,            "name": "locations/1944.../placeActionLinks/abc123",            "providerType": "MERCHANT",            "isEditable": true          }        ]      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Busca detalhes completos dos locais para um conjunto específico de IDs em uma única requisição, com um custo muito menor do que uma GET por local. Tanto locais ativos quanto arquivados são encontrados. Passe os IDs como um array codificado em JSON no parâmetro de consulta ids e aplique a codificação de URL ao valor.

Caso de uso: preencher os dados de um lote de IDs de um webhook ou de uma tarefa. Quando você receber uma lista de IDs de locais (do seu próprio armazenamento, do payload de um webhook ou de uma varredura paginada da lista de locais), obtenha os dados de todos eles de uma só vez: ?ids=["TG9jYXRpb246MTgwMDI4OQ==","TG9jYXRpb246MTgwMDI5MA=="]. Os IDs que não existem na sua conta são omitidos silenciosamente do array, sem gerar um erro, portanto compare a quantidade retornada com a que você solicitou para detectar IDs desatualizados.

Atenção: a chave de consulta é ids. Este endpoint lê o array JSON do parâmetro ids. Agrupar muitos IDs em uma única chamada mantém você bem abaixo do limite de requisições em comparação com executar consultas individuais em um loop; se você fizer essas consultas em paralelo, respeite o cabeçalho Retry-After ao receber um 429.

Cada local retorna placeActionLinks (os links de ação do Google que a Listings API gerencia) e discoveredPlaceActionLinks (links encontrados diretamente no perfil da empresa no Google que ainda não são gerenciados). Consulte o guia de links de ação do local.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations-by-ids?ids=<ids>' \  -H "Authorization: API $LISTINGSAPI_KEY"