listingsAPI

Responses

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.

{
  "data": {
    "planSites": [
      {
        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],
        "id": 1,
        "name": "Google Maps",
        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],
        "url": "maps.google.com"
      },
      {
        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],
        "id": 184,
        "name": "Facebook",
        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],
        "url": "facebook.com"
      },
      {
        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],
        "id": 2,
        "name": "Yelp",
        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],
        "url": "yelp.com"
      }
    ]
  }
}

401Unauthenticated — missing or invalid API key.

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

Returns every publisher directory site included in the plan attached to the current account. Each entry has an integer id, a display name, the site url, the list of ISO country codes the site accepts (supportedCountries), and the countries where the hide-address / service-area flag is honored (hideAddressSupportedCountries).

Use case — build a valid site-ID picker. Before enabling or disabling publishers on a location, call this endpoint to learn which numeric site IDs exist for the plan. Only IDs returned here are valid to pass elsewhere in the API. Map the id to name/url to render a human-readable submission-settings screen.

Use case — pre-flight a location's country. Filter the response to sites whose supportedCountries includes the location's countryIso, so you only offer publishers that will actually accept the listing. For service-area businesses, cross-check hideAddressSupportedCountries to see where the address can be hidden.

Gotchas.

This is a plan-scoped, unpaginated list — it returns the full site catalog for the plan in one response, so there is no cursor. Expect dozens of entries and cache the result rather than calling it per request.
supportedCountries and hideAddressSupportedCountries can each contain 50+ ISO codes; the sample above is truncated.
Shares the account rate limit; on a 429, honor the Retry-After header.

List plan sites

Parameters

Responses