Skip to content
SynupAPI
Get an API key

LocationResponseSchema

Fields

NameTypeRequiredDescription
accountIdintegerrequired
additionalCategoryIdsarray of stringrequired
additionalInfonullrequired
additionalPhonesarray of stringrequired
archivedbooleanrequired
archivedAtnullrequired
billingPeriodnullrequired
bizUrlstringoptional
bookingUrlstringoptional
categoryIdintegerrequired
citystringrequired
countryIsostringrequired
customAttributesarray of objectrequired
customAttributes[].archivedbooleanoptional
customAttributes[].enumValuesarray of stringoptional
customAttributes[].namestringoptional
customAttributes[].slugstringoptional
customAttributes[].typestringoptional
customAttributes[].valuearray of stringoptional
databaseIdintegerrequired
descriptionstringrequired
facebookUrlstringoptional
folderIdstringrequired
folderNamestringrequired
googleAdsPhonestringrequired
googleplusUrlnullrequired
hideAddressbooleanrequired
idstringrequired
instagramUrlstringoptional
isRestaurantbooleanoptional
latitudenumberrequired
linkedinUrlstringoptional
locationPhotosarray of stringrequired
longitudenumberrequired
moreHoursarray of stringrequired
namestringrequired
offeringsUrlstringoptional
ownerEmailstringrequired
ownerNamestringrequired
packagestringrequired
paymentMethodsarray of stringrequired
phonestringrequired
pinterestUrlstringrequired
planIdintegerrequired
planNamestringrequired
postalCodestringrequired
publisherAttributesarray of stringrequired
reservationUrlstringrequired
serviceItemsarray of stringrequired
stateIsostringrequired
storeIdnullrequired
streetstringrequired
street1stringrequired
subCategoryobjectrequired
subCategory.databaseIdintegerrequired
subCategory.idstringrequired
subCategory.namestringrequired
subCategory.primarybooleanrequired
subCategoryIdintegerrequired
subCategoryNamestringrequired
taglinestringrequired
tagsarray of stringrequired
temporarilyClosedbooleanrequired
tiktokUrlnullrequired
toplineMessagenullrequired
toplineMessageTextnullrequired
twitterUrlstringrequired
videosarray of stringrequired
yearOfIncorporationintegerrequired
youtubeUrlnullrequired
placeActionLinksarray of objectoptional
placeActionLinks[].placeActionTypestringrequired
FOOD_ORDERING FOOD_ORDERINGONLINE_APPOINTMENTAPPOINTMENTDINING_RESERVATIONFOOD_DELIVERYFOOD_TAKEOUTSHOP_ONLINE
placeActionLinks[].uristringrequired
placeActionLinks[].isPreferredbooleanoptional
placeActionLinks[].namestringoptional
placeActionLinks[].submissionStatusstringoptional
placeActionLinks[].submissionMessagestringoptional
placeActionLinks[].lastSubmittedAtstringoptional
placeActionLinks[].isEditablestringoptional
discoveredPlaceActionLinksarray of objectoptional
discoveredPlaceActionLinks[].placeActionTypestringrequired
discoveredPlaceActionLinks[].uristringrequired
discoveredPlaceActionLinks[].isPreferredbooleanrequired
discoveredPlaceActionLinks[].namestringrequired
discoveredPlaceActionLinks[].providerTypestringrequired
discoveredPlaceActionLinks[].isEditablebooleanrequired
businessHoursarray of objectoptionalBusiness hours for each day of the week
businessHours[].daystringrequiredDay of the week | Special
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYSPECIAL
businessHours[].slotsarray of objectrequiredArray of time slots (minimum 1, maximum 2). Required only if type is OPEN.
businessHours[].slots[].startstringoptionalOpening time. Valid formats: <HH>:<MM>am OR <HH>:<MM>pm
businessHours[].slots[].endstringoptionalClosing time. Valid formats: <HH>:<MM>am OR <HH>:<MM>pm
businessHours[].typestringrequiredType of business hours (e.g., OPEN, CLOSED, OPEN_24x7)
OPENOPEN_24x7CLOSED
businessHours[].specialDatestringoptionalDay should be SPECIAL. Regular hours is mandatory. Regular hours is mandatory for special hours to be allowed