Synupv1
Create a key
v1Resources/Locations/getList / search locations

List / search locations

Returns a page of locations, newest first. All filters are optional and combine together (a location must match all of them); to page through more results, pass the returned nextCursor back in.

get/api/v1/locations
locations:read
Query parameters
clientIdstringoptional
Restrict results to one client. When your key is scoped to specific clients, this must be one of them. Look it up with GET /api/v1/clients.
searchstringoptional
Free-text search over the location's name, street address, city, or phone (case-insensitive, partial matches allowed).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)optional
A single status bucket: all, active (not archived), archived, archival_pending, verification_pending (Google approval pending), unapproved, or requires_action. Defaults to all.
tagsarray of stringoptional
Internal tags — matches a location that has any of these.
categoriesarray of stringoptional
Category display names — matches a location whose general or Google category is any of these.
verificationarray of string (verified | pending | unverified | unknown)optional
Google verification state: verified, pending, unverified, or unknown.
createdAfterstringoptional
Only locations created on or after this date.
createdBeforestringoptional
Only locations created on or before this date.
cursorstringoptional
Pagination cursor from a previous response's nextCursor. Leave empty for the first page.
limitintegeroptional
Locations to return per page, 1–200. Defaults to 50.
Response
dataobjectoptional
locationsarray of objectoptional
The matching locations for this page.
idstringoptional
Unique identifier for the location.
namestringoptional
The location's business name.
addressstringoptional
The location's street address (combined street lines), or null.
citystringoptional
City.
statestringoptional
State or region.
postalCodestringoptional
Postal or ZIP code, or null.
countrystringoptional
Country, as an ISO-3166-1 alpha-2 code, or null.
phonestringoptional
Primary phone number, or null.
websitestringoptional
The location's website URL, or null.
storeCodestringoptional
Your internal store code / reference for this location, or null.
categorystringoptional
The location's display category (per-publisher primary category if set, else the general category), or null.
tagsarray of stringoptional
Internal tags for your own organization — not shown publicly.
labelsarray of stringoptional
Internal labels for this location.
statusstring (active | archived | archival_pending | verification_pending | unapproved | requires_action)optional
Derived status: active, archived, archival_pending, verification_pending (Google approval pending), unapproved, or requires_action.
verificationStatusstring (verified | pending | unverified | unknown)optional
Google verification state: verified, pending, unverified, or unknown, or null.
pendingChangesnumberoptional
Number of saved edits queued to publish but not yet synced to the connected directories.
lastPublishedAtstringoptional
When this location's details last successfully synced to a publisher, as an ISO 8601 timestamp, or null.
clientIdstringoptional
ID of the client this location belongs to, or null.
clientNamestringoptional
Business name of the client this location belongs to, or null.
createdAtstringoptional
When the location was created, as an ISO 8601 timestamp.
nextCursorstringoptional
Pagination cursor for the next page, or null when there are no more results.
totalnumberoptional
Total number of locations matching the filters, across all pages.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/locations
Your API key
clientId
search
status
tags
categories
verification
createdAfter
createdBefore
cursor
limit
{
  "data": [
    {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123",
      "createdAt": "2026-01-15T10:05:00.000Z"
    }
  ]
}