Locations
Search locations
This API returns a list of locations that match a given keyword. The search can be performed on the following fields:
- Location Name
- Street Address
- Store ID
If no specific fields are provided, the API will search across all available fields by default.
get/locations/search
Request
- Base URLhttps://api.synup.com/api/v4
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
querystring required
Search keyword
fieldsstring[]
Specific fields to search against. If not provided, searches across all fields.
firstinteger
Number of records to fetch from the most recent ones (i.e., from the end). Defaults to 50 if not provided.
lastinteger
Number of records to fetch from the earliest ones (i.e., from the beginning).
afterstring
Cursor to fetch records after
beforestring
Cursor to fetch records before
archivedstring
Filter locations archived true/false
Headers
Authorizationstring required
API key for authentication
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.