Listings APIListings API
Get API keySign in
GET/api/v4/locations/{locationId}/reviews/settings

List review sources for a location

Returns the review sources configured for a single location, with their connection URLs.

Requires an API key. See Authentication for header format and key rotation.

Parameters

Path

NameTypeRequiredDescription
locationIdstringrequiredLocation to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.

Responses

200Review-source sites and their configured URLs for the location.
{
  "data": {
    "interactionsSetting": {
      "siteSettings": [
        { "name": "maps.google.com", "url": null },
        { "name": "facebook.com", "url": null },
        { "name": "yelp.com", "url": null },
        { "name": "tripadvisor.com", "url": null },
        { "name": "yellowpages.com", "url": null },
        { "name": "foursquare.com", "url": null },
        { "name": "opentable.com", "url": null },
        { "name": "trustpilot.com", "url": null }
      ]
    }
  }
}
401Unauthenticated — missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Returns the review-source settings for one location. Each entry in siteSettings is a platform the account's plan supports. A non-null url means that platform is connected and Listings API is pulling reviews from that URL; a null url (as shown above for the live location Jenny Home, which has no third-party sources attached yet) means the platform is available but not yet configured.

Use case: find which sources still need a URL

Fetch this list and filter for url: null to build the punch-list of platforms a location owner still needs to connect. Feed those name values straight into Add or edit review sources to attach the missing URLs:

{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }

After the edit, the same platform comes back with its url populated instead of null.

Use case: audit connected sources across a fleet

Loop your locations (from List all locations) and call this endpoint per location to report review-source coverage. Because it is one request per location, honor the account rate limit — spread the calls out and, on 429, retry after the Retry-After header rather than hammering.

Google and Facebook connected through OAuth surface as connected automatically and cannot be overwritten via the edit endpoint. Use the account-wide List review sources for an account to see the full set of platforms the plan could support.

curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \
  -H "Authorization: API $LISTINGSAPI_KEY"
Run in playground