---
title: "List particular locations"
method: GET
path: "/locations-by-ids"
tags: ["Locations"]
---

# List particular locations

`GET /locations-by-ids`

## Request

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

This API retrieves **detailed information** for one or more **specified location IDs**.

It provides comprehensive data about each location, including its name, address, contact details, business hours, categories, nedia and other relevant attributes.
It support for both active and archived locations.

## Query parameters

- `ids` string[], required

## Headers

- `Authorization` string, required

## Response `200`

- object
  - `data` object, required
    - `getLocationsByIds` object[], required
      - `accountId` integer
      - `addOns` object[]
        - `id` string
        - `name` string
      - `additionalCategoryIds` integer[]
      - `additionalCategoryNames` string[]
      - `additionalInfo` unknown
      - `additionalPhones` string[]
      - `approved` string
      - `archivalScheduledAt` unknown
      - `archived` boolean
      - `archivedAt` unknown
      - `bizUrl` string
      - `bizUrlUtm` boolean
      - `bookingUrl` unknown
      - `businessHours` object[]
        - `day` string, required
        - `slots` object[], nullable, required
          - `end` string, required
          - `start` string, required
        - `specialDate` unknown, required
        - `type` string, required
      - `cancellationScheduledAt` unknown
      - `categoryId` integer
      - `city` string
      - `contentPreferredLanguage` string
      - `countryCode` string
      - `countryIso` string
      - `createErrors` string[]
      - `createdDate` string
      - `customAttributes` object[]
        - `archived` boolean, required
        - `enumValues` string[], required
        - `name` string, required
        - `slug` string, required
        - `type` string, required
        - `value` string[], required
      - `databaseId` integer
      - `description` string
      - `enabledSiteIds` string[]
      - `facebookUrl` string
      - `folderId` string
      - `folderName` string
      - `franchise` unknown
      - `googleAdsPhone` string
      - `googleVerificationStatus` object
        - `message` unknown, required
        - `status` unknown, required
      - `googleplusUrl` unknown
      - `hideAddress` boolean
      - `id` string
      - `instagramUrl` string
      - `isRestaurant` boolean
      - `lastUpdatedDate` string
      - `latitude` string
      - `linkedinUrl` string
      - `locationPhotos` string[]
      - `longitude` string
      - `managedServiceSiteBuckets` string[]
      - `managedServiceSites` string[]
      - `moreHours` string[]
      - `name` string
      - `offeringsUrl` unknown
      - `ownerEmail` string
      - `ownerName` string
      - `package` string
      - `paymentMethods` string[]
      - `phone` string
      - `pinterestUrl` string
      - `planId` integer
      - `planName` unknown
      - `postalCode` string
      - `publisherAttributes` string[]
      - `reservationUrl` unknown
      - `serviceItems` string[]
      - `stateIso` string
      - `stateName` string
      - `storeId` string
      - `street` string
      - `street1` unknown
      - `subCategoryId` integer
      - `subCategoryName` string
      - `tagline` string
      - `tags` string[]
      - `temporarilyClosed` boolean
      - `tiktokUrl` unknown
      - `toplineMessage` unknown
      - `toplineMessageText` unknown
      - `twitterUrl` string
      - `uid` string
      - `updatedAt` string
      - `videos` string[]
      - `voiceStatus` integer
      - `yearOfIncorporation` integer
      - `youtubeUrl` unknown
      - `placeActionLinks` object[]
        - `placeActionType` string, required
        - `uri` string, required
        - `isPreferred` boolean
        - `name` string
        - `submissionStatus` string
        - `submissionMessage` string
        - `lastSubmittedAt` string
      - `discoveredPlaceActionLinks` object[]
        - `placeActionType` string, required
        - `uri` string, required
        - `isPreferred` string, required
        - `name` string, required
        - `providerType` string, required
        - `isEditable` string, required

## Other responses

- `400`: Bad request - Invalid location IDs format
- `401`: Unauthorized - Invalid or missing API key
- `404`: One or more location IDs not found

---

[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)