Listings API

Listings API

REST API for managing business locations: sync listings across Google, Facebook, Bing and other publishers, respond to reviews, publish posts, and pull local…

Finance & banking#business

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

REST API for managing business locations: sync listings across Google, Facebook, Bing and other publishers, respond to reviews, publish posts, and pull local search analytics. Authenticate with an API key from the developer dashboard.

Get a free sandbox API key with the day pass, no card required, when it is offered: sign up at https://listingsapi.com/signup?plan=day-pass&campaign=daypass. It covers the locations and listings endpoints (except listings scans) and syncs only to listingsAPI demo directories. Agents can use the Day pass operations, which need no key; see https://listingsapi.com/sandbox.

Endpoints 85

Locations

  • GETGet locations by the Store Codes./api/v4/locations-by-store-codes?storeCodes=stringReturns full location details for one or more locations identified by their store codes.
  • GETAll locations that belong to an account./api/v4/locationsReturns a cursor-paginated list of locations in your account.
  • POSTCreate a new location./api/v4/locationsCreates a new business location in your account and queues it for listing submission.
  • GETSearch for locations./api/v4/locations/searchReturns a cursor-paginated list of locations matching a keyword, searchable by name, address, or store ID.
  • GETFetch location info via cursor ids./api/v4/locations-by-ids?locationIds=stringReturns full location information for a specified set of location IDs in one request.
  • POSTUpdate information on a location./api/v4/locations/updateUpdates writable fields on an existing location. Only the fields you send are changed.
  • POSTArchive locations./api/v4/locations/archiveSchedules one or more locations for archival at the end of the current billing cycle.
  • POSTCancel archival of locations./api/v4/locations/cancel_archiveCancels a pending archival for locations in ARCHIVE_SCHEDULED status, restoring them to active.
  • GETList media files attached to a single location (starred + unstarred)./api/v4/locations/:locationId/photosReturns all media files attached to a single location, including starred and unstarred photos.
  • GETReturn the status of a bulk add-media-to-location request./api/v4/locations/photos/requests/:requestIdReturns the current processing status for a bulk photo upload request.
  • POSTAttach photos to a location by public image URL./api/v4/locations/photosAttaches media to a location, either by public image URL or by referencing files already in your media library.
  • POSTDetach photos from a location./api/v4/locations/photos/removeDetaches one or more media files from a location by their media IDs.
  • POSTStar or unstar a location's photos. At most four may be starred at once (SY15012)./api/v4/locations/photos/starMarks one or more of a location's additional photos as favourites for priority placement on supported publishers.

Listings

  • GETGet duplicate listings for the given location./api/v4/locations/:locationId/listings/duplicatesReturns duplicate listing entries detected for a single location, grouped by publisher site.
  • GETGet voice assistants for a location./api/v4/locations/:locationId/voice-assistantsReturns the voice assistant listing sync status for a location across Google Assistant, Alexa, Siri, Cortana, and Bixby.
  • GETDuplicate listing rollup for tag./api/v4/locations/listings/duplicatesReturns a paginated, account-wide rollup of potential duplicate listings across every location in the account.
  • POSTMarking the duplicate listing item./api/v4/locations/listings/mark-as-duplicateFlags one or more detected listing items as confirmed duplicates so Listings API can suppress them.
  • POSTMarking the non duplicate listing item./api/v4/locations/listings/mark-as-not-duplicateDismisses one or more potential duplicates as false positives so they stop appearing in the duplicates list.
  • GETGet listings for a location./api/v4/locations/:locationId/listings/premiumReturns the sync status of every publisher directory in a location's plan.

Connected Accounts

  • GETLists all connected account info under users account./api/v4/connected-accountsReturns the Google and Facebook accounts connected to your Listings API account, with connection health and linked-location counts.
  • GETDetails of a connected account/api/v4/connected-accounts/:connectedAccountId/detailsReturns the details of a single connected Google or Facebook account by its ID.
  • POSTConnected Account Listings/api/v4/connected-accounts/connected-account-listingsReturns the Google Business Profile or Facebook listings accessible to a connected account, with optional filtering and pagination.
  • GETReturns all the connection suggestions/api/v4/connected-accounts/:connectedAccountId/connection-suggestionsReturns suggested matches between Listings API locations and Google Business Profile or Facebook listings for a connected account.
  • GETReturns the list of folders in GMB for an email account/api/v4/connected-accounts/:connectedAccountId/foldersReturns the Google Business Profile folders (groups) accessible to a connected Google account.
  • POSTGet google oauth link for bulk connect/api/v4/connected-accounts/connect-googleReturns an OAuth URL to link a Google Business Profile account to your Listings API account.
  • POSTGet facebook oauth link for bulk connect/api/v4/connected-accounts/connect-facebookReturns an OAuth URL to link a Facebook Pages account to your Listings API account.
  • POSTGet google/facebook oauth link/api/v4/locations/oauth_connect_urlCreates a publisher OAuth link that connects a single location, with your own success and error redirects.
  • POSTTriggers match search between listings under connected accounts and platforms locations./api/v4/connected-accounts/trigger-matchesFetches the Google and Facebook profiles for connected accounts and matches them against your Listings API locations.
  • POSTConnects locations with listings for the suggested match records/api/v4/connected-accounts/confirm-matchesConfirms suggested location-to-listing matches returned by the connection suggestions endpoint.
  • POSTBulk disconnect locations/api/v4/connected-accounts/disconnect-googleDisconnects a whole connected Google Business Profile account from your Listings API account.
  • POSTBulk disconnect fb locations/api/v4/connected-accounts/disconnect-facebookDisconnects a previously connected Facebook Pages account from your Listings API account.
  • POSTConnects listing to a location./api/v4/connected-accounts/connect-listingLinks a specific Google Business Profile or Facebook listing to a Listings API location.
  • POSTCreate location from connected account listing/api/v4/connected-accounts/create-location-from-listingCreates a new Listings API location from an existing Google Business Profile or Facebook listing in a connected account.
  • POSTCreate gmb listing for location/api/v4/locations/create/gmb-listingCreates a new Google Business Profile listing for an existing Listings API location and links it to a connected Google account.
  • POSTDelete Connected Accounts Locations/api/v4/connected-accounts/disconnect-listingUnlinks the connected publisher listing from a single Listings API location.
  • POSTDelete Connected Accounts Locations/api/v4/locations/oauth-disconnectSevers a single location's connection to a publisher, the counterpart to the per-location OAuth connect URL.

Reviews

  • GETPaginated list of interactions (reviews / Q&A / social) for a single location, with filters./api/v4/locations/:locationId/reviewsReturns a cursor-paginated list of reviews and social interactions for a single location, with filters.
  • GETPaginated list of interactions across many locations (rollup scope)./api/v4/rollup_interactionsReturns a cursor-paginated list of interactions across many locations in the account, with filtering and sorting.
  • GETNewer per-phrase stats breakdown for one or more locations./api/v4/review-phrasesReturns the phrases customers use most in a location's reviews, each with its own review stats.
  • GETFetch full interaction records by ID./api/v4/reviewDetailsReturns full interaction objects for a specific set of interaction IDs.
  • GETPer-location interactions settings (connected sites, thresholds)./api/v4/locations/:locationId/reviews/settingsReturns the review sources configured for a single location, with their connection URLs.
  • GETAnalytics KPIs for a single location over a date range./api/v4/locations/:locationId/review-analytics-overviewReturns overview review analytics (KPIs) for a location. Two sibling routes return a time-series timeline and a per-site breakdown.
  • GETTime-series review volume / average-rating data for a single location./api/v4/locations/:locationId/review-analytics-timelineReturns a daily time series of review volume and average rating for one location.
  • GETPer-site breakdown of interactions stats for a single location./api/v4/locations/:locationId/review-analytics-sites-statsReturns a per-source breakdown of review volume, rating, and recency for one location.
  • GETPer-site metadata (colors, icons, plan support)./api/v4/reviews/site-configReturns the review platforms available to the account. Google Maps and Facebook are available on every plan, Yelp on Growth and Enterprise.
  • POSTPost a response to a review / Q&A / social interaction on the source site./api/v4/locations/reviews/respondPosts a public response to a review or interaction on its source platform. Common errors SY50121: Google Reviews accept only a single owner reply per review;…
  • POSTUpdate a location's review-source settings (monitored sites) and positive-review threshold./api/v4/locations/reviews/settings/editSets which review sources a location is monitored on, and its positive-review threshold.
  • POSTEdit a previously posted response to a review./api/v4/locations/reviews/respond/editEdits a previously posted owner response on a review or interaction.
  • POSTArchive a response item by ID (soft-delete from the local cache)./api/v4/locations/reviews/respond/archiveArchives an existing owner response, removing it from the active responses tracked for an interaction.

Posts

  • GETIndividual social post view page./api/v4/posts/:postIdReturns a single social post campaign with its content, per-site publish status, and engagement analytics.
  • DELETEDelete a social post./api/v4/posts/:postIdPermanently deletes a social post campaign and removes it from every site it was published to.
  • POSTCreate social posts for multiple locations./api/v4/postsCreates an ANNOUNCEMENT social post and publishes it to the chosen sites for one or more locations.
  • POSTCreate social posts for multiple locations./api/v4/bulk-postsCreates one social post and publishes it across many locations in a single request.
  • GETIndividual social post view page./api/v4/bulk-posts/:postIdReturns a single bulk (multi-location) post campaign with its content, per-location publish status, and engagement analytics.
  • GETPaginated list of posts for a single location, used by the V4 REST /locations/:id/posts endpoint/api/v4/locations/:locationId/postsReturns a page of social post campaigns (announcements, events, offers) that target a single location.
  • GETList of post campaigns for tags/locations./api/v4/locations/:locationId/bulk-postsReturns a page of bulk (multi-location) post campaigns that include a single location.

Social

  • GETList social profiles with optional filter and pagination./api/v4/social/brandsReturns a paginated list of the social brands on your account, with each brand's profile, timezone and connected-channel count.
  • POSTcreateSocialProfile/api/v4/social/brandsCreates a social brand, the container that owns connected social accounts and the posts published from them. Brands are unlimited on API plans.
  • GETFetch summary details for a single social profile./api/v4/social/brands/:brandIdReturns one social brand with its profile details, timezone, archival state and connected-channel count.
  • POSTReturn OAuth connect URLs for a given social profile + channel./api/v4/social/brands/:brandId/connections/linkReturns a short-lived hosted URL that walks an end user through connecting one social platform to a brand.
  • GETlistConnectedChannelWithSocialProfile/api/v4/social/brands/:brandId/connectionsReturns the social accounts connected to a brand, with the platform, display name and archival state of each.
  • GETgetSocialMediaPostByList/api/v4/social/brands/:brandId/postsReturns a paginated list of a brand's social posts with their content, schedule, platforms and per-channel status.
  • GETgetSocialMediaPost/api/v4/social/posts/:postIdReturns one social post with its content, schedule and the live per-channel publish status, link and error.
  • GETStatus and per-row results of one bulk social post job./api/v4/social/bulk-posts/:bulkJobIdReturns the status, counts and per-row results of a bulk social post job.
  • GETgetPostInsightsAndCommentsForSocialChannel/api/v4/social/posts/:postId/insights?socialConnectedChannelId=stringReturns the platform's own engagement payload and comments for one published post on one connected channel.
  • GETfetchAccountLimits/api/v4/social/limitsReturns the account's Social connection cap alongside its billable, active and released connection usage for the current billing period.
  • POSTupdateSocialProfile/api/v4/social/brands/updateUpdates a social brand's name, timezone, website, categories, hashtags or bio.
  • POSTPublish, schedule or draft one post for a brand across its connected channels./api/v4/social/postsCreates a draft, scheduled or immediately published post on a brand's connected Facebook, Instagram, X, LinkedIn and Pinterest accounts.
  • POSTQueue many posts across brands as a single asynchronous job./api/v4/social/bulk-postsValidates and queues up to 500 social posts in one request, returning a job to poll for per-row results.
  • POSTarchiveSocialProfile/api/v4/social/brands/archiveArchives a social brand and takes its connections offline immediately, once the brand has met the 90-day tenure rule; the connection slots are held until the…
  • POSTdisconnectSocialConnectedChannel/api/v4/social/connections/disconnectTakes a connected social account offline immediately; its slot in the account-wide pool is held until the end of the billing period.
  • POSTarchiveScheduledPost/api/v4/social/posts/cancelCancels a scheduled social post before it publishes, leaving already-published posts untouched.

Analytics

  • GETFacebook v4 metrics for a single location over a date range./api/v4/locations/:locationId/facebook-analyticsReturns daily Facebook Page interaction metrics for a location over a date range.
  • GETGoogle My Business v4 metrics for a single location over a date range./api/v4/locations/:locationId/google-analyticsReturns daily Google Business Profile interaction metrics for a location over a date range.
  • GETBing Places v4 metrics for a single location over a date range./api/v4/locations/:locationId/bing-analyticsDeprecated. Bing no longer provides Bing Places insights, so this endpoint returns an empty views array for any range after August 2024.

Business Audit

  • GETGet a listings scan/api/v4/listings/scans/:scanIdReturns one scan with its results, one entry per directory. While the scan is running the results are partial. Scans are kept for 90 days, after which this…
  • GETList listings scans/api/v4/listings/scansReturns the scans of the account, newest first, without their results, together with pageInfo and the monthly quota.
  • POSTCreate a listings scan/api/v4/listings/scansStarts a scan of how any business is listed across the directory network: maps and search engines, data aggregators, local directories, and AI assistants. The…

Supporting APIs

  • GETList of supported countries./api/v4/countriesReturns every country Listings API supports, with its states/provinces, the ISO codes used when creating or updating locations, and which address fields each…
  • GETList of sub-categories./api/v4/sub-categoriesReturns the full catalog of subcategories used to classify locations when creating or updating them.
  • GETAccount plan site details/api/v4/plan-sitesReturns every publisher directory site included in the account's plan, with each site's ID, URL, and supported countries.

Day pass

  • GETGet day pass status and endpoints/api/day-passWhether the day pass is open right now, its limits, and the URLs of the calls below.
  • POSTRequest a day pass/api/day-pass/signupEmails the person a link and a 6-digit code. Send accept_terms: true only once the person has agreed to the Terms of Service and Privacy Policy. One day pass…
  • POSTStart the day pass with the emailed code/api/day-pass/startStarts the 24 hours and returns the API key. The code only works with the poll_token of the request it was emailed for. A retry within 10 minutes returns the…
  • POSTPoll until the owner starts the day pass/api/day-pass/statusAnswers {"status": "pending"} with a Retry-After header until the owner presses Start my day pass in the email, then returns the same credentials as the start…

API details

Base URL
https://listingsapi.com
Authentication
An API key in the Authorization header
An API key in the X-RapidAPI-Key header
An API key in the X-RapidAPI-Host header
Operations
85 operations on 81 pathsGET 44POST 40DELETE 1
Main resources
Connected Accounts 17Social 16Locations 13Reviews 13Posts 7Listings 6Day pass 4Analytics 3Business Audit 3Supporting APIs 3
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 2026-11-05

How to test the Listings API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Listings API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get locations by the Store Codes.” (GET /api/v4/locations-by-store-codes?storeCodes=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Listings API?

REST API for managing business locations: sync listings across Google, Facebook, Bing and other publishers, respond to reviews, publish posts, and pull local… It is listed under Finance & banking and has 85 endpoints.

Who publishes the Listings API?

It is listed from Listings API's public API description (an OpenAPI document), not published by Listings API on Swastik Codes. Anyone who controls listingsapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Listings API?

Requests go to https://listingsapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the Listings API?

It accepts 3 methods: an API key in the Authorization header; an API key in the X-RapidAPI-Key header; an API key in the X-RapidAPI-Host header.

How many endpoints does the Listings API have?

85 operations on 81 paths (44 GET, 40 POST, 1 DELETE). The largest groups are Connected Accounts, Social, Locations, Reviews.

Is forking the Listings API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.