v1Resources/Locations/getSuggest location groups
Suggest location groups
Finds locations not in a group that share a phone number, biggest set first, with a suggested name from their common name prefix. A suggestion with `groupId` set shares the number of an existing group (even a single location): add it with POST /api/v1/location-groups/{groupId}/locations instead of creating a group. Suggestions only; nothing is grouped until you create or add.
get
locations:read/api/v1/location-groups/suggestionsQuery parameters
clientIdstringoptional
Limit suggestions to one client's locations.
Response
dataobjectoptional
suggestionsarray of objectoptional
phonestringoptional
The shared phone number.
locationIdsarray of stringoptional
Locations sharing it that are not in a group.
locationsarray of objectoptional
idstringoptional
namestringoptional
citystringoptional
locationCountintegeroptional
clientIdsarray of stringoptional
suggestedNamestringoptional
A name from the locations' common name prefix.
groupIdstringoptional
Set when an existing group already uses this number: add the locations to it.
groupNamestringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/location-groups/suggestions
Your API key
clientId
{}Guides that use this resource
- What Is a Business Listings API?A business listings API manages a business's name, address, hours and more across many publishers at once, with sync status and duplicate detection built in.
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Create a Location with the Synup APICreate a business location in one POST, with or without a client, get back a locationId, and know which fields matter and which can wait.
- Google Business Profile API vs a Listings Management APIHow Google's Business Profile API compares with a listings management API on scope, access, sync status, duplicates and reviews, and when to use each.
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Manage Business Listings ProgrammaticallyKeep business listings accurate from your own system with the Synup API. Covers change detection, idempotent updates, hours, photos and sync reporting.
- Update a Location's Opening Hours via APISet a weekly schedule with the Synup API, handle split shifts and 24-hour days, and avoid the read-versus-write time format that breaks naive diffs.
- How to Update Business Information Across Google, Apple, Bing and DirectoriesPush one business-information change to Google, Apple, Bing and the directory network through a single API call, and verify it reached each publisher.
- How Listing Syndication WorksListing syndication takes one business record, translates it into each publisher's format, and pushes it out asynchronously, which is why sync status matters.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- Temporarily Close a Business Location via APIMark a location closed for a holiday or a renovation with specialHours, and why you must not use archival for a temporary closure.
- How Google Business Profile Synchronization WorksGoogle Business Profile sync rests on an owner's OAuth consent, matching a location to the right Google listing, then a write-and-verify loop.
- Upload Business Photos via APIAdd photos to a location by category with the Synup API, from a public URL or base64, and avoid uploading the same image twice on a schedule.
- Read a Location's Google Photos from Stored DataList the Google Business Profile photos Synup has stored for a location, owner and customer, with freshness and paging, without calling Google.
- How to Connect and Manage Google Business Profiles via APIConnect a Google Business Profile to a location, match the account's listings, keep the profile in sync and handle reconnects with the Synup API.
- Building Publisher Integrations Directly vs Using SynupWhat it really costs to integrate Google, Apple, Bing and directories yourself, versus one API, and how to decide between them or combine both.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.