---
title: "Search locations"
method: GET
path: "/locations/search"
tags: ["Locations"]
---

# Search locations

`GET /locations/search`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/search`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/search/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `query` string, required
- `fields` string[]
- `first` integer
- `last` integer
- `after` string
- `before` string
- `archived` string

## Headers

- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object, required
    - `searchLocations` object, required
      - `edges` object[], required
        - `cursor` string, required
        - `node` object, required
          - `accountId` integer, required
          - `addOns` string[], required
          - `additionalCategoryIds` integer[], required
          - `additionalCategoryNames` string[], required
          - `additionalInfo` unknown, required
          - `additionalPhones` string[], required
          - `approved` string, required
          - `archivalScheduledAt` unknown, required
          - `archived` boolean, required
          - `archivedAt` unknown, required
          - `bizUrl` unknown, required
          - `bizUrlUtm` boolean, required
          - `bookingUrl` unknown, required
          - `businessHours` object[], required
            - `day` string, required
            - `slots` object[], required
              - …
            - `specialDate` unknown, required
            - `type` string, required
          - `cancellationScheduledAt` unknown, required
          - `categoryId` integer, required
          - `city` string, required
          - `contentPreferredLanguage` string, required
          - `countryCode` string, required
          - `countryIso` string, required
          - `createErrors` string[], required
          - `createdDate` string, required
          - `customAttributes` object[], required
            - `archived` boolean, required
            - `enumValues` string[], required
            - `name` string, required
            - `slug` string, required
            - `type` string, required
            - `value` string[], required
          - `databaseId` integer, required
          - `description` string, required
          - `enabledSiteIds` string[], required
          - `facebookUrl` string, nullable, required
          - `folderId` string, required
          - `folderName` string, required
          - `franchise` boolean, required
          - `googleAdsPhone` string, nullable, required
          - `googleVerificationStatus` object, required
            - `message` unknown, required
            - `status` string, required
          - `googleplusUrl` unknown, required
          - `hideAddress` boolean, required
          - `id` string, required
          - `instagramUrl` unknown, required
          - `isRestaurant` boolean, required
          - `lastUpdatedDate` string, required
          - `latitude` string, required
          - `linkedinUrl` string, nullable, required
          - `locationPhotos` object[], required
            - `databaseId` integer, required
            - `fileSize` integer, required
            - `id` string, required
            - `name` string, required
            - `starred` boolean, required
            - `thumbnailUrl` string, required
            - `type` string, required
            - `url` string, required
          - `longitude` string, required
          - `managedServiceSiteBuckets` string[], required
          - `managedServiceSites` string[], required
          - `moreHours` string[], required
          - `name` string, required
          - `offeringsUrl` unknown, required
          - `ownerEmail` string, nullable, required
          - `ownerName` string, nullable, required
          - `package` string, required
          - `paymentMethods` string[], required
          - `phone` string, required
          - `pinterestUrl` unknown, required
          - `planId` integer, required
          - `planName` string, required
          - `postalCode` string, required
          - `publisherAttributes` object[], required
            - `attributeName` string
            - `publisherName` string
            - `value` string[]
          - `reservationUrl` unknown, required
          - `serviceItems` string[], required
          - `stateIso` string, required
          - `stateName` string, required
          - `storeId` string, required
          - `street` string, required
          - `street1` string, required
          - `subCategoryId` integer, required
          - `subCategoryName` string, required
          - `tagline` string, nullable, required
          - `tags` string[], required
          - `temporarilyClosed` boolean, required
          - `tiktokUrl` unknown, required
          - `toplineMessage` unknown, required
          - `toplineMessageText` unknown, required
          - `twitterUrl` string, nullable, required
          - `uid` string, required
          - `updatedAt` string, required
          - `videos` string[], required
          - `voiceStatus` integer, required
          - `yearOfIncorporation` integer, nullable, required
          - `youtubeUrl` unknown, required
      - `pageInfo` object, required
        - `endCursor` string, required
        - `hasNextPage` boolean, required
        - `hasPreviousPage` boolean, required
        - `total` integer, required

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)