Locations

Filter locations

Returns a paginated list of locations that match the supplied filters.

The filter criteria are passed as a single JSON-encoded object in the input query parameter. Supported filter keys include name/store/phone search (query, storeId, phone), location identifiers (ids), package tier (package), tags, folders, categories, address filters (postalCode, city, stateIso), custom attributes (customAttributes), GBP categories (primaryGbpSiteCategories, additionalGbpSiteCategories), add-ons (addOnIds), Google verification status (googleVerificationStatus), and client account scoping (clientIds).

Results are returned as a Relay-style connection (edges + pageInfo). Use the first/after (or last/before) parameters to page through results.

get/locations/filter

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/locations/filter/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

inputstring

JSON-encoded filter object. See the description for supported keys. Defaults to an empty filter (all locations).

firstinteger

Number of records to return from the start of the result set.

afterstring

Cursor to fetch records after.

lastinteger

Number of records to return from the end of the result set.

beforestring

Cursor to fetch records before.

archivedboolean

Filter by archived state (true/false).

approvedboolean

Filter by approved state (true/false).

hasErrorsboolean

Return only locations that currently have errors.

archivalScheduledAtboolean

Return only locations scheduled for archival.

blacklistIdsstring[]

Location IDs to exclude from the result set.

sortByNameAscboolean

Sort results by location name ascending.

Headers

Synup-Versionstring required

API version date (YYYY-MM-DD).

Authorizationstring required

API key for authentication.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.