GETapi.synup.com/api/v4/locations
List all locations
This API retrieves a paginated list of locations within the account, allowing for efficient data retrieval when managing multiple locations.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
first | integer | optional | Number of records to fetch from the most recent ones (i.e., from the end). Defaults to 50 if not provided. |
last | integer | optional | Number of records to fetch from the earliest ones (i.e., from the beginning). |
after | string | optional | Cursor to fetch records after |
before | string | optional | Cursor to fetch records before |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/locations?first=&last=&after=&before=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/locations?first=&last=&after=&before=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/locations?first=&last=&after=&before=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations?first=&last=&after=&before=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
400 | Bad location ID or invalid parameters |
Example response
{
"data": {
"allLocations": {
"edges": [
{
"cursor": "TG9jYXRpb246MTE5NTI1OA==",
"node": {
"accountId": 16154,
"addOns": [],
"additionalCategoryIds": [
43
],
"additionalCategoryNames": [
"Playgrounds"
],
"additionalInfo": null,
"additionalPhones": [],
"approved": "APPROVED",
"archivalScheduledAt": null,
"archived": false,
"archivedAt": null,
"bizUrl": "https://headsupcatchme.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": "09:00pm",
"start": "09:00am"
}
],
"specialDate": null,
"type": "OPEN"
},
{
"day": "WEDNESDAY",
"slots": [
{
"end": "11:30am",
"start": "09:00am"
},
{
"end": "05:00pm",
"start": "01:00pm"
},
{
"end": "09:30pm",
"start": "06:00pm"
}
],
"specialDate": null,
"type": "OPEN"
},
{
"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": 59,
"city": "Setauket- East Setauket",
"countryIso": "US",
"createErrors": [
{
"fieldName": "base",
"messages": [
"A Location with same name, phone number and zip code has already been added."
]
},
{
"fieldName": "storeId",
"messages": [
"Store has already been taken"
]
}
],
"createdDate": "February 19, 2025",
"customAttributes": [
{
"archived": false,
"enumValues": [],
"name": "bollean01",
"slug": "bollean01",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "KAM",
"slug": "kam",
"type": "STRING",
"value": [
""
]
},
{
"archived": false,
"enumValues": [],
"name": "P_Test01",
"slug": "p_test01",
"type": "STRING",
"value": [
"one12"
]
},
{
"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",
"type": "ARRAY",
"value": [
"wifi",
"wheelchair",
"welcoming ceremony"
]
},
{
"archived": false,
"enumValues": [],
"name": "amenities02",
"slug": "amenities02",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "Amenities-check",
"slug": "amenities-check",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [],
"name": "is owned by veterans",
"slug": "is_owned_by_veterans",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [
"Atr1",
"atr2",
"atr3"
],
"name": "Prod_Attribute",
"slug": "prod_attribute",
"type": "ENUM",
"value": [
"Atr1"
]
},
{
"archived": false,
"enumValues": [],
"name": "wifi available",
"slug": "wifi_available",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "QQQQQQQ",
"slug": "qqqqqqq",
"type": "INTEGER",
"value": [
"123"
]
},
{
"archived": false,
"enumValues": [],
"name": "int02",
"slug": "int02",
"type": "INTEGER",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Tasty",
"slug": "tasty",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "dhdop",
"slug": "dhdop",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Abstract",
"slug": "abstract",
"type": "ARRAY",
"value": [
"abs1",
"abs2",
"abs3"
]
},
{
"archived": false,
"enumValues": [],
"name": "Senior Hours Required?",
"slug": "senior_hours_required?",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "kafka_check_attribute",
"slug": "kafka_check_attribute",
"type": "ARRAY",
"value": [
"one",
"two",
"three"
]
},
{
"archived": false,
"enumValues": [],
"name": "Parking",
"slug": "parking",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [],
"name": "googlePlaceId",
"slug": "googleplaceid",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "hoursComments",
"slug": "hourscomments",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "isOpen",
"slug": "isopen",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "has_bicycle_rack?",
"slug": "has_bicycle_rack?",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [
"one",
"two"
],
"name": "quick",
"slug": "quick",
"type": "ENUM",
"value": [
"one"
]
},
{
"archived": false,
"enumValues": [],
"name": "instagramUrl",
"slug": "instagramurl",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "analyticsTrackingFireEvent",
"slug": "analyticstrackingfireevent",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "placeholderText",
"slug": "placeholdertext",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [
"FRND",
"MENMENMEN",
"BARNEY"
],
"name": "TV",
"slug": "tv",
"type": "ENUM",
"value": [
"FRND"
]
},
{
"archived": false,
"enumValues": [],
"name": "notificationEmails",
"slug": "notificationemails",
"type": "ARRAY",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "joinUrl",
"slug": "joinurl",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "account_att",
"slug": "account_att",
"type": "ARRAY",
"value": [
"1",
"2",
"4",
"3"
]
},
{
"archived": false,
"enumValues": [],
"name": "Post v2",
"slug": "post_v2",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "testingthetest",
"slug": "testingthetest",
"type": "INTEGER",
"value": [
"0"
]
},
{
"archived": false,
"enumValues": [],
"name": "int0",
"slug": "int0",
"type": "INTEGER",
"value": [
"0"
]
},
{
"archived": false,
"enumValues": [],
"name": "url_appointment",
"slug": "url_appointment",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Slug",
"slug": "slug",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "New Name",
"slug": "new_name",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "test200",
"slug": "test200",
"type": "STRING",
"value": [
"test test"
]
},
{
"archived": false,
"enumValues": [],
"name": "Name",
"slug": "name",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Test Department ",
"slug": "test_department_",
"type": "ARRAY",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Fresh Fish Section ",
"slug": "fresh_fish_section_",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Test 28 11 22",
"slug": "test_28_11_22",
"type": "STRING",
"value": [
"Test 28"
]
},
{
"archived": false,
"enumValues": [],
"name": "blablacar",
"slug": "blablacar",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "requires temperature check customers",
"slug": "requires_temperature_check_customers",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "Custom Tee Point",
"slug": "custom_tee_point",
"type": "STRING",
"value": [
"tess"
]
},
{
"archived": false,
"enumValues": [],
"name": "appointment_required",
"slug": "appointment_required",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "requires masks customers",
"slug": "requires_masks_customers",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "is black owned",
"slug": "is_black_owned",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "BewAttribute",
"slug": "bewattribute",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Pets 2 ",
"slug": "pets_2_",
"type": "ARRAY",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "test214122",
"slug": "test214122",
"type": "STRING",
"value": [
"test2"
]
},
{
"archived": false,
"enumValues": [],
"name": "Test123",
"slug": "test123",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "ohiiiignore",
"slug": "ohiiiignore",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "yesnotest",
"slug": "yesnotest",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "account_leve_test_for_ext",
"slug": "account_leve_test_for_ext",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Custom location ID",
"slug": "custom_location_id",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Account Attr",
"slug": "account_attr",
"type": "ARRAY",
"value": [
"one",
"two",
"three"
]
},
{
"archived": false,
"enumValues": [
"b",
"a",
"c"
],
"name": "enum01",
"slug": "enum01",
"type": "ENUM",
"value": [
"a"
]
},
{
"archived": false,
"enumValues": [],
"name": "Paneer Speciality",
"slug": "paneer_speciality",
"type": "STRING",
"value": [
"https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg"
]
},
{
"archived": false,
"enumValues": [],
"name": "welcomes_lgbtq",
"slug": "welcomes_lgbtq",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "Lgbtq+ friendly",
"slug": "lgbtq+_friendly",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "analyticsTrackingScript",
"slug": "analyticstrackingscript",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "is owned by women",
"slug": "is_owned_by_women",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "has wheelchair accessible seating",
"slug": "has_wheelchair_accessible_seating",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [],
"name": "has restroom",
"slug": "has_restroom",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [],
"name": "has_wheelchair_accessible_restroom",
"slug": "has_wheelchair_accessible_restroom",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "has restroom unisex",
"slug": "has_restroom_unisex",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [],
"name": "is transgender safespace",
"slug": "is_transgender_safespace",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "welcomes_lgbtq",
"slug": "welcomes_lgbtq",
"type": "BOOLEAN",
"value": [
"true"
]
}
],
"databaseId": 1195258,
"description": "About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business",
"enabledSiteIds": [],
"facebookUrl": null,
"folderId": "401228fe-8ee9-4914-a08a-db7cda490ec9",
"folderName": "root",
"franchise": false,
"googleAdsPhone": "6314848881",
"googleVerificationStatus": {
"message": null,
"status": null
},
"googleplusUrl": null,
"hideAddress": false,
"id": "TG9jYXRpb246MTE5NTI1OA==",
"instagramUrl": null,
"isRestaurant": false,
"lastUpdatedDate": "February 19, 2025",
"latitude": "40.9366839",
"linkedinUrl": "https://www.linkedin.com/in/ac-slater-hey/",
"locationPhotos": [
{
"databaseId": 6020661,
"fileSize": 44693,
"id": "TWVkaWFGaWxlOjYwMjA2NjE=",
"name": "43700ee9-5291-4e5e-bf8a-165f724f55b4.jpg",
"starred": false,
"thumbnailUrl": "https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4a64cfad-a6b3-4de9-9238-ffbd89aaa7b2.jpg",
"type": "LOGO",
"url": "https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4a64cfad-a6b3-4de9-9238-ffbd89aaa7b2.jpg"
},
{
"databaseId": 6020659,
"fileSize": 138594,
"id": "TWVkaWFGaWxlOjYwMjA2NTk=",
"name": "7ead4509-01c0-4c59-85ac-9c710fed53f2.jpg",
"starred": false,
"thumbnailUrl": "https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/cf49f33f-1220-429e-9f86-4f64ade0a7be.jpg",
"type": "COVER",
"url": "https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/cf49f33f-1220-429e-9f86-4f64ade0a7be.jpg"
}
],
"longitude": "-73.1081977",
"managedServiceSiteBuckets": [],
"managedServiceSites": [],
"moreHours": [],
"name": "Benjamin Auditor House",
"offeringsUrl": null,
"ownerEmail": null,
"ownerName": null,
"package": "PREMIUM",
"paymentMethods": [],
"phone": "6314848880",
"pinterestUrl": null,
"planId": 86,
"planName": "V2 Premium Slow + Fast Sites",
"postalCode": "11733",
"publisherAttributes": [],
"reservationUrl": null,
"serviceItems": [
{
"categoryId": "3996",
"currencyCode": "USD",
"description": "simple menu",
"id": "01c522d6-9e9b-4234-9978-61c10f35e4ef",
"languageCode": null,
"name": "Buffet",
"price": 100
},
{
"categoryId": "3996",
"currencyCode": null,
"description": null,
"id": "4360744c-26fa-46f8-9aea-b3a104e1f0b3",
"languageCode": null,
"name": "Swing",
"price": null
},
{
"categoryId": "3996",
"currencyCode": null,
"description": null,
"id": "13675b09-88a7-48c1-901f-f455e7be1994",
"languageCode": null,
"name": "Drive Through",
"price": null
},
{
"categoryId": "3996",
"currencyCode": null,
"description": "Fine dining or whatever just have food and go home!!!",
"id": "4ccff7cd-a292-429a-a7d0-49101b91db1d",
"languageCode": null,
"name": "Fine Dining",
"price": null
},
{
"categoryId": "3996",
"currencyCode": "USD",
"description": "A happy-sounding, but soul-stirring music that will have you hum it for hours after you have got off the carousel!",
"id": "cf786095-edba-4ef2-820f-4fe198834742",
"languageCode": null,
"name": "Merry-go-round",
"price": 10
}
],
"stateIso": "NY",
"stateName": "New York",
"storeId": "shop_code_benji",
"street": "1368 Route 25A, United States, 100 NY-25A, #22",
"street1": null,
"subCategoryId": 3996,
"subCategoryName": "International airport",
"tagline": null,
"tags": [
"all",
"label_in_google"
],
"temporarilyClosed": false,
"tiktokUrl": null,
"toplineMessage": null,
"toplineMessageText": null,
"twitterUrl": "https://twitter.com/journeymus",
"uid": "716d9b63-0158-4463-83a2-ee1014a13cec",
"updatedAt": "2025-02-19T07:24:51.689Z",
"videos": [],
"voiceStatus": 1,
"yearOfIncorporation": null,
"youtubeUrl": "https://www.youtube.com/@JayGuldekar2.0"
}
},
{
"cursor": "TG9jYXRpb246MTE5NTI1Mg==",
"node": {
"accountId": 16154,
"addOns": [],
"additionalCategoryIds": [],
"additionalCategoryNames": [],
"additionalInfo": null,
"additionalPhones": [],
"approved": "APPROVED",
"archivalScheduledAt": null,
"archived": false,
"archivedAt": null,
"bizUrl": "http://valencarestaurantnj.com/",
"bizUrlUtm": false,
"bookingUrl": null,
"businessHours": [],
"cancellationScheduledAt": null,
"categoryId": 15,
"city": "Elizabeth",
"countryIso": "US",
"createErrors": [],
"createdDate": "February 19, 2025",
"customAttributes": [
{
"archived": false,
"enumValues": [],
"name": "bollean01",
"slug": "bollean01",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "KAM",
"slug": "kam",
"type": "STRING",
"value": [
""
]
},
{
"archived": false,
"enumValues": [],
"name": "P_Test01",
"slug": "p_test01",
"type": "STRING",
"value": [
"one12"
]
},
{
"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",
"type": "ARRAY",
"value": [
"wifi",
"wheelchair",
"welcoming ceremony"
]
},
{
"archived": false,
"enumValues": [],
"name": "amenities02",
"slug": "amenities02",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "Amenities-check",
"slug": "amenities-check",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [
"Atr1",
"atr2",
"atr3"
],
"name": "Prod_Attribute",
"slug": "prod_attribute",
"type": "ENUM",
"value": [
"Atr1"
]
},
{
"archived": false,
"enumValues": [],
"name": "wifi available",
"slug": "wifi_available",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "QQQQQQQ",
"slug": "qqqqqqq",
"type": "INTEGER",
"value": [
"123"
]
},
{
"archived": false,
"enumValues": [],
"name": "int02",
"slug": "int02",
"type": "INTEGER",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Tasty",
"slug": "tasty",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "dhdop",
"slug": "dhdop",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Abstract",
"slug": "abstract",
"type": "ARRAY",
"value": [
"abs1",
"abs2",
"abs3"
]
},
{
"archived": false,
"enumValues": [],
"name": "Senior Hours Required?",
"slug": "senior_hours_required?",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "kafka_check_attribute",
"slug": "kafka_check_attribute",
"type": "ARRAY",
"value": [
"one",
"two",
"three"
]
},
{
"archived": false,
"enumValues": [],
"name": "Parking",
"slug": "parking",
"type": "BOOLEAN",
"value": [
"false"
]
},
{
"archived": false,
"enumValues": [],
"name": "googlePlaceId",
"slug": "googleplaceid",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "hoursComments",
"slug": "hourscomments",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "isOpen",
"slug": "isopen",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "has_bicycle_rack?",
"slug": "has_bicycle_rack?",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [
"one",
"two"
],
"name": "quick",
"slug": "quick",
"type": "ENUM",
"value": [
"one"
]
},
{
"archived": false,
"enumValues": [],
"name": "instagramUrl",
"slug": "instagramurl",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "analyticsTrackingFireEvent",
"slug": "analyticstrackingfireevent",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "placeholderText",
"slug": "placeholdertext",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [
"FRND",
"MENMENMEN",
"BARNEY"
],
"name": "TV",
"slug": "tv",
"type": "ENUM",
"value": [
"FRND"
]
},
{
"archived": false,
"enumValues": [],
"name": "notificationEmails",
"slug": "notificationemails",
"type": "ARRAY",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "joinUrl",
"slug": "joinurl",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "account_att",
"slug": "account_att",
"type": "ARRAY",
"value": [
"1",
"2",
"4",
"3"
]
},
{
"archived": false,
"enumValues": [],
"name": "Post v2",
"slug": "post_v2",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "testingthetest",
"slug": "testingthetest",
"type": "INTEGER",
"value": [
"0"
]
},
{
"archived": false,
"enumValues": [],
"name": "int0",
"slug": "int0",
"type": "INTEGER",
"value": [
"0"
]
},
{
"archived": false,
"enumValues": [],
"name": "url_appointment",
"slug": "url_appointment",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Slug",
"slug": "slug",
"type": "STRING",
"value": [
"/new-york/elizabeth/665-monroe-ave"
]
},
{
"archived": false,
"enumValues": [],
"name": "New Name",
"slug": "new_name",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "test200",
"slug": "test200",
"type": "STRING",
"value": [
"test test"
]
},
{
"archived": false,
"enumValues": [],
"name": "Name",
"slug": "name",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Test Department ",
"slug": "test_department_",
"type": "ARRAY",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Fresh Fish Section ",
"slug": "fresh_fish_section_",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Test 28 11 22",
"slug": "test_28_11_22",
"type": "STRING",
"value": [
"Test 28"
]
},
{
"archived": false,
"enumValues": [],
"name": "accepts reservation",
"slug": "accepts_reservation",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "blablacar",
"slug": "blablacar",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "requires temperature check customers",
"slug": "requires_temperature_check_customers",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "Custom Tee Point",
"slug": "custom_tee_point",
"type": "STRING",
"value": [
"tess"
]
},
{
"archived": false,
"enumValues": [],
"name": "appointment_required",
"slug": "appointment_required",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "requires masks customers",
"slug": "requires_masks_customers",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "is black owned",
"slug": "is_black_owned",
"type": "BOOLEAN",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "BewAttribute",
"slug": "bewattribute",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Pets 2 ",
"slug": "pets_2_",
"type": "ARRAY",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "test214122",
"slug": "test214122",
"type": "STRING",
"value": [
"test2"
]
},
{
"archived": false,
"enumValues": [],
"name": "Test123",
"slug": "test123",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "ohiiiignore",
"slug": "ohiiiignore",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "yesnotest",
"slug": "yesnotest",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "account_leve_test_for_ext",
"slug": "account_leve_test_for_ext",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Custom location ID",
"slug": "custom_location_id",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "Account Attr",
"slug": "account_attr",
"type": "ARRAY",
"value": [
"one",
"two",
"three"
]
},
{
"archived": false,
"enumValues": [
"b",
"a",
"c"
],
"name": "enum01",
"slug": "enum01",
"type": "ENUM",
"value": [
"a"
]
},
{
"archived": false,
"enumValues": [],
"name": "Paneer Speciality",
"slug": "paneer_speciality",
"type": "STRING",
"value": [
"https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg"
]
},
{
"archived": false,
"enumValues": [],
"name": "welcomes_lgbtq",
"slug": "welcomes_lgbtq",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "Lgbtq+ friendly",
"slug": "lgbtq+_friendly",
"type": "BOOLEAN",
"value": [
"true"
]
},
{
"archived": false,
"enumValues": [],
"name": "analyticsTrackingScript",
"slug": "analyticstrackingscript",
"type": "STRING",
"value": []
},
{
"archived": false,
"enumValues": [],
"name": "url_menu",
"slug": "url_menu",
"type": "STRING",
"value": []
}
],
"databaseId": 1195252,
"description": "",
"enabledSiteIds": [],
"facebookUrl": null,
"folderId": "401228fe-8ee9-4914-a08a-db7cda490ec9",
"folderName": "root",
"franchise": false,
"googleAdsPhone": null,
"googleVerificationStatus": {
"message": null,
"status": "NOT_CONNECTED"
},
"googleplusUrl": null,
"hideAddress": false,
"id": "TG9jYXRpb246MTE5NTI1Mg==",
"instagramUrl": null,
"isRestaurant": true,
"lastUpdatedDate": "February 19, 2025",
"latitude": "40.6770873",
"linkedinUrl": null,
"locationPhotos": [],
"longitude": "-74.2031927",
"managedServiceSiteBuckets": [],
"managedServiceSites": [],
"moreHours": [],
"name": "Valenca Restaurant",
"offeringsUrl": null,
"ownerEmail": null,
"ownerName": null,
"package": "PREMIUM",
"paymentMethods": [],
"phone": "9083544024",
"pinterestUrl": null,
"planId": 86,
"planName": "V2 Premium Slow + Fast Sites",
"postalCode": "07201",
"publisherAttributes": [],
"reservationUrl": null,
"serviceItems": [],
"stateIso": "NY",
"stateName": "New York",
"storeId": null,
"street": "665 Monroe Ave",
"street1": null,
"subCategoryId": 1432,
"subCategoryName": "Restaurants",
"tagline": null,
"tags": [
"all"
],
"temporarilyClosed": false,
"tiktokUrl": null,
"toplineMessage": null,
"toplineMessageText": null,
"twitterUrl": null,
"uid": "b49e138a-430d-4b88-9b0b-e24de2708c69",
"updatedAt": "2025-02-19T06:01:46.686Z",
"videos": [],
"voiceStatus": 3,
"yearOfIncorporation": null,
"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
}
]
}
}
],
"pageInfo": {
"endCursor": "TG9jYXRpb246MTE5NTI1Mg==",
"hasNextPage": true,
"hasPreviousPage": false,
"total": 4989
}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.allLocations | object | optional | |
data.allLocations.edges | array of object | optional | |
data.allLocations.edges[].cursor | string | optional | |
data.allLocations.edges[].node | object | optional | |
data.allLocations.edges[].node.accountId | integer | required | |
data.allLocations.edges[].node.additionalCategoryIds | array of string | required | |
data.allLocations.edges[].node.additionalInfo | null | required | |
data.allLocations.edges[].node.additionalPhones | array of string | required | |
data.allLocations.edges[].node.archived | boolean | required | |
data.allLocations.edges[].node.archivedAt | null | required | |
data.allLocations.edges[].node.billingPeriod | null | required | |
data.allLocations.edges[].node.bizUrl | string | optional | |
data.allLocations.edges[].node.bookingUrl | string | optional | |
data.allLocations.edges[].node.categoryId | integer | required | |
data.allLocations.edges[].node.city | string | required | |
data.allLocations.edges[].node.countryIso | string | required | |
data.allLocations.edges[].node.customAttributes | array of object | required | |
data.allLocations.edges[].node.customAttributes[].archived | boolean | optional | |
data.allLocations.edges[].node.customAttributes[].enumValues | array of string | optional | |
data.allLocations.edges[].node.customAttributes[].name | string | optional | |
data.allLocations.edges[].node.customAttributes[].slug | string | optional | |
data.allLocations.edges[].node.customAttributes[].type | string | optional | |
data.allLocations.edges[].node.customAttributes[].value | array of string | optional | |
data.allLocations.edges[].node.databaseId | integer | required | |
data.allLocations.edges[].node.description | string | required | |
data.allLocations.edges[].node.facebookUrl | string | optional | |
data.allLocations.edges[].node.folderId | string | required | |
data.allLocations.edges[].node.folderName | string | required | |
data.allLocations.edges[].node.googleAdsPhone | string | required | |
data.allLocations.edges[].node.googleplusUrl | null | required | |
data.allLocations.edges[].node.hideAddress | boolean | required | |
data.allLocations.edges[].node.id | string | required | |
data.allLocations.edges[].node.instagramUrl | string | optional | |
data.allLocations.edges[].node.isRestaurant | boolean | optional | |
data.allLocations.edges[].node.latitude | number | required | |
data.allLocations.edges[].node.linkedinUrl | string | optional | |
data.allLocations.edges[].node.locationPhotos | array of string | required | |
data.allLocations.edges[].node.longitude | number | required | |
data.allLocations.edges[].node.moreHours | array of string | required | |
data.allLocations.edges[].node.name | string | required | |
data.allLocations.edges[].node.offeringsUrl | string | optional | |
data.allLocations.edges[].node.ownerEmail | string | required | |
data.allLocations.edges[].node.ownerName | string | required | |
data.allLocations.edges[].node.package | string | required | |
data.allLocations.edges[].node.paymentMethods | array of string | required | |
data.allLocations.edges[].node.phone | string | required | |
data.allLocations.edges[].node.pinterestUrl | string | required | |
data.allLocations.edges[].node.planId | integer | required | |
data.allLocations.edges[].node.planName | string | required | |
data.allLocations.edges[].node.postalCode | string | required | |
data.allLocations.edges[].node.publisherAttributes | array of string | required | |
data.allLocations.edges[].node.reservationUrl | string | required | |
data.allLocations.edges[].node.serviceItems | array of string | required | |
data.allLocations.edges[].node.stateIso | string | required | |
data.allLocations.edges[].node.storeId | null | required | |
data.allLocations.edges[].node.street | string | required | |
data.allLocations.edges[].node.street1 | string | required | |
data.allLocations.edges[].node.subCategory | object | required | |
data.allLocations.edges[].node.subCategory.databaseId | integer | required | |
data.allLocations.edges[].node.subCategory.id | string | required | |
data.allLocations.edges[].node.subCategory.name | string | required | |
data.allLocations.edges[].node.subCategory.primary | boolean | required | |
data.allLocations.edges[].node.subCategoryId | integer | required | |
data.allLocations.edges[].node.subCategoryName | string | required | |
data.allLocations.edges[].node.tagline | string | required | |
data.allLocations.edges[].node.tags | array of string | required | |
data.allLocations.edges[].node.temporarilyClosed | boolean | required | |
data.allLocations.edges[].node.tiktokUrl | null | required | |
data.allLocations.edges[].node.toplineMessage | null | required | |
data.allLocations.edges[].node.toplineMessageText | null | required | |
data.allLocations.edges[].node.twitterUrl | string | required | |
data.allLocations.edges[].node.videos | array of string | required | |
data.allLocations.edges[].node.yearOfIncorporation | integer | required | |
data.allLocations.edges[].node.youtubeUrl | null | required | |
data.allLocations.edges[].node.placeActionLinks | array of object | optional | |
data.allLocations.edges[].node.placeActionLinks[].placeActionType | string | required | FOOD_ORDERING FOOD_ORDERINGONLINE_APPOINTMENTAPPOINTMENTDINING_RESERVATIONFOOD_DELIVERYFOOD_TAKEOUTSHOP_ONLINE |
data.allLocations.edges[].node.placeActionLinks[].uri | string | required | |
data.allLocations.edges[].node.placeActionLinks[].isPreferred | boolean | optional | |
data.allLocations.edges[].node.placeActionLinks[].name | string | optional | |
data.allLocations.edges[].node.placeActionLinks[].submissionStatus | string | optional | |
data.allLocations.edges[].node.placeActionLinks[].submissionMessage | string | optional | |
data.allLocations.edges[].node.placeActionLinks[].lastSubmittedAt | string | optional | |
data.allLocations.edges[].node.placeActionLinks[].isEditable | string | optional | |
data.allLocations.edges[].node.discoveredPlaceActionLinks | array of object | optional | |
data.allLocations.edges[].node.discoveredPlaceActionLinks[].placeActionType | string | required | |
data.allLocations.edges[].node.discoveredPlaceActionLinks[].uri | string | required | |
data.allLocations.edges[].node.discoveredPlaceActionLinks[].isPreferred | boolean | required | |
data.allLocations.edges[].node.discoveredPlaceActionLinks[].name | string | required | |
data.allLocations.edges[].node.discoveredPlaceActionLinks[].providerType | string | required | |
data.allLocations.edges[].node.discoveredPlaceActionLinks[].isEditable | boolean | required | |
data.allLocations.edges[].node.businessHours | array of object | optional | Business hours for each day of the week |
data.allLocations.edges[].node.businessHours[].day | string | required | Day of the week | SpecialMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYSPECIAL |
data.allLocations.edges[].node.businessHours[].slots | array of object | required | Array of time slots (minimum 1, maximum 2). Required only if type is OPEN. |
data.allLocations.edges[].node.businessHours[].slots[].start | string | optional | Opening time. Valid formats: <HH>:<MM>am OR <HH>:<MM>pm |
data.allLocations.edges[].node.businessHours[].slots[].end | string | optional | Closing time. Valid formats: <HH>:<MM>am OR <HH>:<MM>pm |
data.allLocations.edges[].node.businessHours[].type | string | required | Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7)OPENOPEN_24x7CLOSED |
data.allLocations.edges[].node.businessHours[].specialDate | string | optional | Day should be SPECIAL. Regular hours is mandatory. Regular hours is mandatory for special hours to be allowed |
data.allLocations.pageInfo | object | optional | |
data.allLocations.pageInfo.hasNextPage | boolean | optional | Indicates if there are more pages available |
data.allLocations.pageInfo.hasPreviousPage | boolean | optional | Indicates if there are previous pages available |
data.allLocations.pageInfo.totalPages | integer | optional | Total number of pages available |
data.allLocations.pageInfo.totalRecords | integer | optional | Total number of records across all pages |