- Getting Started
- Locations
- Location AttributesMARKDOWN
- Photo specifications for your business locationMARKDOWN
- Star and Unstar PhotosMARKDOWN
- Create a new business locationPOST
- Update business locationPOST
- List all locationsGET
- List particular locationsGET
- Search locationsGET
- Get locations by store codesGET
- Get Photos by Location IDsGET
- Upload Photos to a LocationPOST
- Check Bulk Photo Upload StatusGET
- Star/Unstar Location PhotosPOST
- Delete Location PhotosPOST
- Archive multiple locationsPOST
- Cancel scheduled location archivalPOST
- Activate archived locationsPOST
- List Active SubscriptionsGET
- Get a list of supported countries and their statesGET
- Get SubCategories and AdditionalCategoriesGET
- Get Site Details for Your PlanGET
- Location Indexing RateGET
- Location Attributes
- Organizing locations
- Organizing locationsMARKDOWN
- Create a new folderPOST
- List all foldersGET
- List all folders under an account in hierarchical structureGET
- Get details of a folderGET
- Rename a folderPOST
- Add locations to a folderPOST
- Remove locations from a folderPOST
- Delete a folderPOST
- List locations under a folderGET
- List all tagsGET
- List locations by tagsGET
- Add location to a tagPOST
- Remove location from a tagPOST
- Organizing locations
- User Management
- Grid Rank
- Review Campaigns
- Listings
- Connected Accounts
- Connected Accounts
- Connect Google Profile to Account
- Connect Facebook Page to Account
- List all connected accounts
- List folders under a Google account
- Create GMB Listing
- Disconnect GMB Profile
- Disconnect Facebook Account
- Fetch Connected Account Details
- Trigger New Matches
- List Connection Suggestions
- Fetch Connected Account Listings
- Confirm Connected Account Matches
- Connect a location with a listing of a connected account
- Disconnect Location from Listing
- create location from connected account listing
- Rankings
- Profile Analytics
- Reviews
- Automations
- Error Codes
- Schemas
- Sample Schemas
- Schemas
- FolderSchema
- LocationResponseSchema
- LocationResponseErrorSchema
- SubCategory
- SubscriptionsResponse
- CreateFolderRequest
- FolderNode
- ListingsResponse
- LocationListResponse
- ConnectGoogleInput
- ConnectFacebookInput
- DisconnectGoogleRequest
- TriggerMatchesRequest
- FetchListingsRequest
- ConfirmMatchesRequest
- ConnectListingRequest
- DisconnectListingRequest
- ConnectedAccountDetailsResponse
- ConnectionSuggestionsResponse
- Keyword
- Keyword
- Keyword
- UnauthorizedError
- UnauthorizedError
- UnauthorizedError
- UnauthorizedError
- InsightMetric
- InsightMetric
- CreateGridReportInput
- AllGridReportsResponse
- GridReportResponse
- CreateUserInput
- UsersResponse
- UsersResponse
- UsersByIdsResponse
- AnalyticsOverview
- Interaction
- Interaction
- InteractionsResponse
- ResponseInteraction
- AddLocationsInput
- UserRole
- UserRole
- CreateReviewCampaignRequest
- ReviewCampaignsResponse
- ReviewCampaignCustomersResponse
- PremiumListing
- Subscription
- CreateFolderResponse
- Listing
- ConnectGoogleResponse
- ConnectFacebookResponse
- DisconnectGoogleResponse
- ConnectedAccount
- TriggerMatchesResponse
- ConfirmMatchesResponse
- ConnectListingResponse
- DisconnectListingResponse
- Error
- Error
- BadRequestError
- BadRequestError
- BadRequestError
- NotFoundError
- UnauthorizedError
- UnauthorizedError
- CreateGridReportResponse
- GridReport
- GridReport
- CreateUserResponse
- PageInfo
- PageInfo
- UserDetail
- AnalyticsTimeline
- Response
- Response
- PageInfo
- AddLocationsResponse
- Pagination
- Pagination
- CustomerInput
- ReviewCampaign
- ReviewCampaignInfo
- Tag
- SearchResponse
- LocationPhoto
- CustomAttribute
- Folder
- Site
- ConnectedAccountsResponse
- LocationListing
- ListingRecord
- ConnectionSuggestion
- NotFoundError
- NotFoundError
- RankPoint
- RankPoint
- CreatedUser
- UserEdge
- UserEdge
- SiteWiseAnalytics
- InteractionEdge
- LocationAddStatus
- LandingPageTemplate
- EmailTemplate
- ReviewCampaignCustomer
- LocationEdge
- Error
- FetchListingsResponse
- LocationInfo
- User
- User
- MetricWithDelta
- Interaction
- EmailTemplate
- SmsTemplate
- SuggestedLocationInfo
- SMSTemplate
- CampaignStat
- PageInfo
- ReviewSite
- BusinessHours
- AddCustomersRequest
- Business hours
- paymentMethods
- Contact Support
Search locations
GET
https://api.synup.com/api/v4/locations/search
This API returns a list of locations that match a given keyword. The search can be performed on the following fields:
Request
Query Params
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.synup.com/api/v4/locations/search?query=test&fields=store_id&first=50&last=50&after&before&archived=false' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'Responses
🟢200OK
application/json
Body
Example
{
"data": {
"searchLocations": {
"edges": [
{
"cursor": "TG9jYXRpb246NTI3NDY5",
"node": {
"accountId": 16154,
"addOns": [],
"additionalCategoryIds": [],
"additionalCategoryNames": [],
"additionalInfo": null,
"additionalPhones": [],
"approved": "NOT_APPROVED",
"archivalScheduledAt": null,
"archived": false,
"archivedAt": null,
"bizUrl": null,
"bizUrlUtm": false,
"bookingUrl": null,
"businessHours": [],
"cancellationScheduledAt": null,
"categoryId": 15,
"city": "Sacramento",
"contentPreferredLanguage": "ENGLISH",
"countryCode": "1",
"countryIso": "US",
"createErrors": [],
"createdDate": "February 23, 2021",
"customAttributes": [
{
"archived": false,
"enumValues": [],
"name": "ABC",
"slug": "abc",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "NJL",
"slug": "njl",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "ZZZ",
"slug": "zzz",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "ALL",
"slug": "all",
"type": "STRING",
"value": [
"ss"
]
},
{
"archived": false,
"enumValues": [
"gulab jamun",
"rasgulla",
"ras malai",
"jalebi"
],
"name": "Dessets",
"slug": "dessets",
"type": "ENUM",
"value": [
"gulab jamun"
]
},
{
"archived": false,
"enumValues": [],
"name": "Attrs",
"slug": "attrs",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Attrs2",
"slug": "attrs2",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Toll-free Number",
"slug": "toll-free_number",
"type": "INTEGER",
"value": [
"80044637"
]
},
{
"archived": false,
"enumValues": [],
"name": "amenities",
"slug": "amenities",
"typModified at 2025-12-15 10:42:35