Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/locations-by-ids

List particular locations

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.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

NameTypeRequiredDescription
idsarrayrequiredArray of location IDs in JSON string format.

Request

Request
curl -X GET 'https://api.synup.com/api/v4/locations-by-ids?ids=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200
400Bad request - Invalid location IDs format
401Unauthorized - Invalid or missing API key
404One or more location IDs not found
Example response
{
  "data": {
    "getLocationsByIds": [
      {
        "accountId": 11073,
        "addOns": [
          {
            "id": "1",
            "name": "Yelp Lite"
          }
        ],
        "additionalCategoryIds": [
          609
        ],
        "additionalCategoryNames": [
          "Framing"
        ],
        "additionalInfo": null,
        "additionalPhones": [
          "6036610058"
        ],
        "approved": "APPROVED",
        "archivalScheduledAt": null,
        "archived": false,
        "archivedAt": null,
        "bizUrl": "www.easports222.com",
        "bizUrlUtm": false,
        "bookingUrl": null,
        "businessHours": [
          {
            "day": "SUNDAY",
            "slots": null,
            "specialDate": null,
            "type": "CLOSED"
          },
          {
            "day": "MONDAY",
            "slots": [
              {
                "end": "05:00pm",
                "start": "09:00am"
              }
            ],
            "specialDate": null,
            "type": "OPEN"
          },
          {
            "day": "TUESDAY",
            "slots": [
              {
                "end": "01:00pm",
                "start": "09:00am"
              },
              {
                "end": "05:00pm",
                "start": "02:00pm"
              }
            ],
            "specialDate": null,
            "type": "OPEN"
          },
          {
            "day": "WEDNESDAY",
            "slots": null,
            "specialDate": null,
            "type": "OPEN_24x7"
          },
          {
            "day": "THURSDAY",
            "slots": null,
            "specialDate": null,
            "type": "OPEN_24x7"
          },
          {
            "day": "FRIDAY",
            "slots": null,
            "specialDate": null,
            "type": "CLOSED"
          },
          {
            "day": "SATURDAY",
            "slots": null,
            "specialDate": null,
            "type": "CLOSED"
          }
        ],
        "cancellationScheduledAt": null,
        "categoryId": 1,
        "city": "New York",
        "contentPreferredLanguage": "ENGLISH",
        "countryCode": "1",
        "countryIso": "US",
        "createErrors": [],
        "createdDate": "December 15, 2025",
        "customAttributes": [
          {
            "archived": false,
            "enumValues": [],
            "name": "Atributo",
            "slug": "atributo",
            "type": "STRING",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "offers_online_appointments",
            "slug": "offers_online_appointments",
            "type": "BOOLEAN",
            "value": [
              "false"
            ]
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "welcomes_lgbtq",
            "slug": "welcomes_lgbtq",
            "type": "BOOLEAN",
            "value": [
              "true"
            ]
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "has wheelchair",
            "slug": "has_wheelchair",
            "type": "BOOLEAN",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "utm",
            "slug": "utm",
            "type": "STRING",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "Slug",
            "slug": "slug",
            "type": "STRING",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "Name",
            "slug": "name",
            "type": "STRING",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "accept digital rupee",
            "slug": "accept_digital_rupee",
            "type": "INTEGER",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "has_onsite_parking",
            "slug": "has_onsite_parking",
            "type": "BOOLEAN",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "Test 23",
            "slug": "test_23",
            "type": "STRING",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "lead_photo_drive",
            "slug": "lead_photo_drive",
            "type": "STRING",
            "value": []
          },
          {
            "archived": false,
            "enumValues": [],
            "name": "Test French Locale 4",
            "slug": "test_french_locale_4",
            "type": "STRING",
            "value": []
          }
        ],
        "databaseId": 88350,
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. This is a sample description which is used to complete the 200 characters. Let us believe this has exceeded the character limit otherwise it is going to be a headache to go and change it again. But still to be on the careful side, I am adding a few more line of characters because of which this is going to work.",
        "enabledSiteIds": [],
        "facebookUrl": "https://www.facebook.com/journeywithanthony/",
        "folderId": "57e34303-e9fd-422d-ad39-383849df7ea9",
        "folderName": "hello12341",
        "franchise": null,
        "googleAdsPhone": "8289989989",
        "googleVerificationStatus": {
          "message": null,
          "status": null
        },
        "googleplusUrl": null,
        "hideAddress": false,
        "id": "TG9jYXRpb246ODgzNTA=",
        "instagramUrl": "https://www.instagram.com/rajinikanth/",
        "isRestaurant": false,
        "lastUpdatedDate": "December 15, 2025",
        "latitude": "40.712775",
        "linkedinUrl": "https://www.linkedin.com/company/synup/",
        "locationPhotos": [],
        "longitude": "-74.005973",
        "managedServiceSiteBuckets": [],
        "managedServiceSites": [],
        "moreHours": [],
        "name": "Spinka Group",
        "offeringsUrl": null,
        "ownerEmail": "pttqa1+212@gmail.com",
        "ownerName": "John Doe",
        "package": "PREMIUM",
        "paymentMethods": [
          "VISA",
          "MASTERCARD",
          "AMEX",
          "CASH",
          "CHEQUE",
          "CRYPTO",
          "DINERS_CLUB",
          "DISCOVER",
          "FINANCING",
          "INVOICE",
          "TRAVELERS_CHECK",
          "APPLE_PAY",
          "SAMSUNG_PAY",
          "PAYPAL",
          "ANDROID_PAY"
        ],
        "phone": "6036610058",
        "pinterestUrl": "https://pinterest.com/cozylivin77/",
        "planId": 59,
        "planName": null,
        "postalCode": "60605",
        "publisherAttributes": [],
        "reservationUrl": null,
        "serviceItems": [],
        "stateIso": "NY",
        "stateName": "New York",
        "storeId": "995si",
        "street": "123 Jump Street",
        "street1": null,
        "subCategoryId": 20,
        "subCategoryName": "Pilates",
        "tagline": "We Exist",
        "tags": [
          "all",
          "pk"
        ],
        "temporarilyClosed": false,
        "tiktokUrl": null,
        "toplineMessage": null,
        "toplineMessageText": null,
        "twitterUrl": "https://twitter.com/elonmusk",
        "uid": "0afc0561-04e0-4e72-b679-318310c1a8f1",
        "updatedAt": "2025-12-15T10:06:47.776Z",
        "videos": [
          "https://www.youtube.com/watch?v=QKmrDUJFRkM"
        ],
        "voiceStatus": 1,
        "yearOfIncorporation": 1179,
        "youtubeUrl": null,
        "placeActionLinks": [
          {
            "placeActionType": "FOOD_ORDERING",
            "uri": "https://order.example.com",
            "isPreferred": true,
            "name": "locations/1944.../placeActionLinks/54ada85bc246058a",
            "submissionStatus": "success",
            "submissionMessage": "Already up to date on Google.",
            "lastSubmittedAt": "2026-07-08T12:14:36Z"
          }
        ],
        "discoveredPlaceActionLinks": [
          {
            "placeActionType": "APPOINTMENT",
            "uri": "https://book.example.com",
            "isPreferred": false,
            "name": "locations/1944.../placeActionLinks/abc123",
            "providerType": "MERCHANT",
            "isEditable": true
          }
        ]
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectrequired
data.getLocationsByIdsarray of objectrequired
data.getLocationsByIds[].accountIdintegeroptional
data.getLocationsByIds[].addOnsarray of objectoptional
data.getLocationsByIds[].addOns[].idstringoptional
data.getLocationsByIds[].addOns[].namestringoptional
data.getLocationsByIds[].additionalCategoryIdsarray of integeroptional
data.getLocationsByIds[].additionalCategoryNamesarray of stringoptional
data.getLocationsByIds[].additionalInfonulloptional
data.getLocationsByIds[].additionalPhonesarray of stringoptional
data.getLocationsByIds[].approvedstringoptional
data.getLocationsByIds[].archivalScheduledAtnulloptional
data.getLocationsByIds[].archivedbooleanoptional
data.getLocationsByIds[].archivedAtnulloptional
data.getLocationsByIds[].bizUrlstringoptional
data.getLocationsByIds[].bizUrlUtmbooleanoptional
data.getLocationsByIds[].bookingUrlnulloptional
data.getLocationsByIds[].businessHoursarray of objectoptional
data.getLocationsByIds[].businessHours[].daystringrequired
data.getLocationsByIds[].businessHours[].slotsarray of objectrequired
data.getLocationsByIds[].businessHours[].slots[].endstringrequired
data.getLocationsByIds[].businessHours[].slots[].startstringrequired
data.getLocationsByIds[].businessHours[].specialDatenullrequired
data.getLocationsByIds[].businessHours[].typestringrequired
data.getLocationsByIds[].cancellationScheduledAtnulloptional
data.getLocationsByIds[].categoryIdintegeroptional
data.getLocationsByIds[].citystringoptional
data.getLocationsByIds[].contentPreferredLanguagestringoptional
data.getLocationsByIds[].countryCodestringoptional
data.getLocationsByIds[].countryIsostringoptional
data.getLocationsByIds[].createErrorsarray of stringoptional
data.getLocationsByIds[].createdDatestringoptional
data.getLocationsByIds[].customAttributesarray of objectoptional
data.getLocationsByIds[].customAttributes[].archivedbooleanrequired
data.getLocationsByIds[].customAttributes[].enumValuesarray of stringrequired
data.getLocationsByIds[].customAttributes[].namestringrequired
data.getLocationsByIds[].customAttributes[].slugstringrequired
data.getLocationsByIds[].customAttributes[].typestringrequired
data.getLocationsByIds[].customAttributes[].valuearray of stringrequired
data.getLocationsByIds[].databaseIdintegeroptional
data.getLocationsByIds[].descriptionstringoptional
data.getLocationsByIds[].enabledSiteIdsarray of stringoptional
data.getLocationsByIds[].facebookUrlstringoptional
data.getLocationsByIds[].folderIdstringoptional
data.getLocationsByIds[].folderNamestringoptional
data.getLocationsByIds[].franchisenulloptional
data.getLocationsByIds[].googleAdsPhonestringoptional
data.getLocationsByIds[].googleVerificationStatusobjectoptional
data.getLocationsByIds[].googleVerificationStatus.messagenullrequired
data.getLocationsByIds[].googleVerificationStatus.statusnullrequired
data.getLocationsByIds[].googleplusUrlnulloptional
data.getLocationsByIds[].hideAddressbooleanoptional
data.getLocationsByIds[].idstringoptional
data.getLocationsByIds[].instagramUrlstringoptional
data.getLocationsByIds[].isRestaurantbooleanoptional
data.getLocationsByIds[].lastUpdatedDatestringoptional
data.getLocationsByIds[].latitudestringoptional
data.getLocationsByIds[].linkedinUrlstringoptional
data.getLocationsByIds[].locationPhotosarray of stringoptional
data.getLocationsByIds[].longitudestringoptional
data.getLocationsByIds[].managedServiceSiteBucketsarray of stringoptional
data.getLocationsByIds[].managedServiceSitesarray of stringoptional
data.getLocationsByIds[].moreHoursarray of stringoptional
data.getLocationsByIds[].namestringoptional
data.getLocationsByIds[].offeringsUrlnulloptional
data.getLocationsByIds[].ownerEmailstringoptional
data.getLocationsByIds[].ownerNamestringoptional
data.getLocationsByIds[].packagestringoptional
data.getLocationsByIds[].paymentMethodsarray of stringoptional
data.getLocationsByIds[].phonestringoptional
data.getLocationsByIds[].pinterestUrlstringoptional
data.getLocationsByIds[].planIdintegeroptional
data.getLocationsByIds[].planNamenulloptional
data.getLocationsByIds[].postalCodestringoptional
data.getLocationsByIds[].publisherAttributesarray of stringoptional
data.getLocationsByIds[].reservationUrlnulloptional
data.getLocationsByIds[].serviceItemsarray of stringoptional
data.getLocationsByIds[].stateIsostringoptional
data.getLocationsByIds[].stateNamestringoptional
data.getLocationsByIds[].storeIdstringoptional
data.getLocationsByIds[].streetstringoptional
data.getLocationsByIds[].street1nulloptional
data.getLocationsByIds[].subCategoryIdintegeroptional
data.getLocationsByIds[].subCategoryNamestringoptional
data.getLocationsByIds[].taglinestringoptional
data.getLocationsByIds[].tagsarray of stringoptional
data.getLocationsByIds[].temporarilyClosedbooleanoptional
data.getLocationsByIds[].tiktokUrlnulloptional
data.getLocationsByIds[].toplineMessagenulloptional
data.getLocationsByIds[].toplineMessageTextnulloptional
data.getLocationsByIds[].twitterUrlstringoptional
data.getLocationsByIds[].uidstringoptional
data.getLocationsByIds[].updatedAtstringoptional
data.getLocationsByIds[].videosarray of stringoptional
data.getLocationsByIds[].voiceStatusintegeroptional
data.getLocationsByIds[].yearOfIncorporationintegeroptional
data.getLocationsByIds[].youtubeUrlnulloptional
data.getLocationsByIds[].placeActionLinksarray of objectoptional
data.getLocationsByIds[].placeActionLinks[].placeActionTypestringrequired
data.getLocationsByIds[].placeActionLinks[].uristringrequired
data.getLocationsByIds[].placeActionLinks[].isPreferredbooleanoptional
data.getLocationsByIds[].placeActionLinks[].namestringoptional
data.getLocationsByIds[].placeActionLinks[].submissionStatusstringoptional
data.getLocationsByIds[].placeActionLinks[].submissionMessagestringoptional
data.getLocationsByIds[].placeActionLinks[].lastSubmittedAtstringoptional
data.getLocationsByIds[].discoveredPlaceActionLinksarray of objectoptional
data.getLocationsByIds[].discoveredPlaceActionLinks[].placeActionTypestringrequired
data.getLocationsByIds[].discoveredPlaceActionLinks[].uristringrequired
data.getLocationsByIds[].discoveredPlaceActionLinks[].isPreferredstringrequired
data.getLocationsByIds[].discoveredPlaceActionLinks[].namestringrequired
data.getLocationsByIds[].discoveredPlaceActionLinks[].providerTypestringrequired
data.getLocationsByIds[].discoveredPlaceActionLinks[].isEditablestringrequired