listingsAPI

Name	Type	Required	Description
locationId	string	required	Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

Name

Type

Required

Description

locationId

string

required

Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

Responses

200Array of voice assistant listings with per-assistant sync status.

{
  "data": {
    "voiceAssistantsForLocation": [
      {
        "databaseId": "104468723",
        "voiceIdentifier": "GOOGLE_ASSISTANT",
        "name": "Google Assistant",
        "connectedAccountId": null,
        "syncStatus": "REQUIRING_ACTION",
        "actionRequired": true,
        "syncIssue": null,
        "errors": []
      },
      {
        "databaseId": "104468711",
        "voiceIdentifier": "SIRI",
        "name": "Siri",
        "connectedAccountId": null,
        "syncStatus": "IN_PROGRESS",
        "actionRequired": false,
        "syncIssue": "Google connection is required.",
        "errors": []
      },
      {
        "databaseId": "104468714",
        "voiceIdentifier": "ALEXA",
        "name": "Alexa",
        "connectedAccountId": null,
        "syncStatus": "IN_PROGRESS",
        "actionRequired": false,
        "syncIssue": null,
        "errors": []
      }
    ]
  }
}

401Unauthenticated — missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Returns the voice assistant listing status for a single location. listingsAPI syncs location data to Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana, and Samsung Bixby so the business surfaces in voice search results. The locationId path segment accepts the base64 node ID from any location response, or the raw numeric database ID — both resolve to the same location.

Use case — surface "action required" voice listings in a dashboard. Render a per-location voice-readiness widget by iterating the array and flagging every entry where actionRequired is true or syncIssue is non-null. In the sample above, Google Assistant and Bixby need attention, while Siri reports "Google connection is required." — a common blocker because Apple's voice results are seeded from the Google Business Profile connection. Deep-link those rows to your connect-Google flow so the customer can clear the dependency.

Sync status values: IN_PROGRESS (submission underway), REQUIRING_ACTION (customer input needed before listingsAPI can sync), LIVE (published), and NOT_SUBMITTED. errors is an array of publisher-side error strings; connectedAccountId links the assistant to the connected account driving the sync when one applies (e.g. Google Assistant via the Google connection).

This endpoint counts against your account rate limit. If you poll voice status across many locations, page through them with the locations list endpoint and space calls out — a 429 includes a Retry-After header telling you when to resume.

Get voice assistant listings for a location

Parameters

Path

Responses