Entity Language Profiles: Get
Retrieve a Language Profile for an Entity
NOTE:
- Responses will contain resolved values for embedded fields
- If the
fields
parameter is unspecified, responses will contain the full entity profile for the requested language
path Parameters
accountId required | string >= 0 characters |
entityId required | string >= 0 characters The external ID of the requested Entity |
languageCode required | string >= 0 characters The language code corresponding to the language of the profiles that the user wishes to retrieve |
query Parameters
v required | string >= 0 characters A date in |
fields | string >= 0 characters Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., |
format | string >= 0 characters Default: "markdown" Present if and only if at least one field is of type "Rich Text." Valid values:
|
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "entityType": "string",
- "folderId": "string",
- "id": "string",
- "labels": [
- "string"
], - "language": "string",
- "timestamp": "string",
- "uid": "string"
}, - "name": "string",
- "address": {
- "city": "string",
- "countryCode": "string",
- "extraDescription": "string",
- "line1": "string",
- "line2": "string",
- "postalCode": "string",
- "region": "string",
- "sublocality": "string"
}, - "acceptingNewPatients": true,
- "acceptsReservations": true,
- "accessHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "additionalHoursText": "string",
- "additionalPromotingLocations": [
- "string"
], - "addressHidden": true,
- "admittingHospitals": [
- "string"
], - "adultPool": "YES",
- "ageRange": {
- "maxValue": 0,
- "minValue": 0
}, - "airportShuttle": "AIRPORT_SHUTTLE_AVAILABLE",
- "airportTransfer": "YES",
- "allInclusive": "ALL_INCLUSIVE_RATES_AVAILABLE",
- "alternateNames": [
- "string"
], - "alternatePhone": "string",
- "androidAppUrl": "string",
- "answer": "string",
- "associations": [
- "string"
], - "attire": "UNSPECIFIED",
- "babysittingOffered": "YES",
- "baggageStorage": "YES",
- "bar": "YES",
- "beachAccess": "YES",
- "beachFrontProperty": "YES",
- "bicycles": "BICYCLE_RENTALS",
- "bios": {
- "ids": [
- "string"
], - "label": "string"
}, - "boutiqueStores": "YES",
- "brands": [
- "string"
], - "breakfast": "BREAKFAST_AVAILABLE",
- "brunchHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "businessCenter": "YES",
- "calendars": {
- "ids": [
- "string"
], - "label": "string"
}, - "carRental": "YES",
- "casino": "YES",
- "categoryIds": [
- "string"
], - "catsAllowed": "YES",
- "certifications": [
- "string"
], - "checkInTime": "14:15:22Z",
- "checkOutTime": "14:15:22Z",
- "classificationRating": "string",
- "closed": true,
- "concierge": "YES",
- "conditionsTreated": [
- "string"
], - "convenienceStore": "YES",
- "covidMessaging": "string",
- "covidTestingAppointmentRequired": true,
- "covidTestingDriveThroughSite": true,
- "covidTestingIsFree": true,
- "covidTestingPatientRestrictions": true,
- "covidTestingReferralRequired": true,
- "covidTestingSiteInstructions": "string",
- "covidVaccineAppointmentRequired": true,
- "covidVaccineDriveThroughSite": true,
- "covidVaccinePatientRestrictions": true,
- "covidVaccineReferralRequired": true,
- "covidVaccineSiteInstructions": "string",
- "covidVaccinesOffered": [
- "PFIZER"
], - "currencyExchange": "YES",
- "customKeywords": [
- "string"
], - "datePosted": "2019-08-24",
- "degrees": [
- "ANP"
], - "deliveryHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "description": "stringstri",
- "displayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "doctorOnCall": "YES",
- "dogsAllowed": "YES",
- "driveThroughHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "dropoffCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "educationList": [
- {
- "institutionName": "string",
- "type": "FELLOWSHIP",
- "yearCompleted": 1900
}
], - "electricChargingStation": "YES",
- "elevator": "YES",
- "ellipticalMachine": "YES",
- "emails": [
- "user@example.com"
], - "employmentType": "FULL_TIME",
- "eventStatus": "SCHEDULED",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookVanityUrl": "string",
- "fax": "string",
- "firstName": "string",
- "firstPartyReviewPage": "string",
- "fitnessCenter": "FITNESS_CENTER_AVAILABLE",
- "floorCount": 0,
- "freeWeights": "YES",
- "frequentlyAskedQuestions": [
- {
- "answer": "string",
- "question": "string"
}
], - "frontDesk": "FRONT_DESK_AVAILABLE",
- "fullyVaccinatedStaff": true,
- "gameRoom": "YES",
- "gender": "UNSPECIFIED",
- "geomodifier": "string",
- "giftShop": "YES",
- "golf": "YES",
- "googleAttributes": { },
- "googleMyBusinessLabels": [
- "string"
], - "googlePlaceId": "string",
- "happyHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "hiringOrganization": "string",
- "holidayHoursConversationEnabled": true,
- "horsebackRiding": "YES",
- "hotTub": "YES",
- "hours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "housekeeping": "HOUSEKEEPING_AVAILABLE",
- "impressum": "string",
- "indoorPoolCount": 0,
- "instagramHandle": "string",
- "insuranceAccepted": [
- "string"
], - "iosAppUrl": "string",
- "isClusterPrimary": true,
- "isFreeEvent": true,
- "isoRegionCode": "string",
- "keywords": [
- "string"
], - "kidFriendly": "YES",
- "kidsClub": "YES",
- "kidsStayFree": "YES",
- "kitchenHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "labels": [
- "string"
], - "languages": [
- "string"
], - "lastName": "string",
- "laundry": "FULL_SERVICE",
- "lazyRiver": "YES",
- "lifeguard": "YES",
- "linkedLocation": "string",
- "localPhone": "string",
- "localShuttle": "YES",
- "locatedIn": "string",
- "location": {
- "existingLocation": "string",
- "externalLocation": "string"
}, - "locationType": "LOCATION",
- "logo": {
- "description": "string",
- "details": "string",
}, - "mainPhone": "string",
- "massage": "YES",
- "maxAgeOfKidsStayFree": 0,
- "maxNumberOfKidsStayFree": 0,
- "mealsServed": [
- "BREAKFAST"
], - "meetingRoomCount": 0,
- "menuUrl": {
- "preferDisplayUrl": true,
}, - "menus": {
- "ids": [
- "string"
], - "label": "string"
}, - "middleName": "string",
- "mobilePhone": "string",
- "mobilityAccessible": "YES",
- "nightclub": "YES",
- "npi": "string",
- "nudgeEnabled": true,
- "officeName": "string",
- "onlineServiceHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "ALIPAY"
], - "performers": [
- "string"
], - "petsAllowed": "PETS_WELCOME",
- "photoGallery": [
- {
- "description": "string",
- "details": "string",
}
], - "pickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "pickupHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "priceRange": "UNSPECIFIED",
- "primaryConversationContact": "string",
- "privateBeach": "YES",
- "privateCarService": "PRIVATE_CAR_SERVICE",
- "productLists": {
- "ids": [
- "string"
], - "label": "string"
}, - "products": [
- "string"
], - "questionsAndAnswers": true,
- "rankTrackingEnabled": true,
- "rankTrackingFrequency": "WEEKLY",
- "rankTrackingQueryTemplates": [
- "KEYWORD"
], - "rankTrackingSites": [
- "GOOGLE_DESKTOP"
], - "reservationUrl": {
- "preferDisplayUrl": true,
}, - "restaurantCount": 0,
- "reviewGenerationUrl": "string",
- "reviewResponseConversationEnabled": true,
- "roomCount": 0,
- "roomService": "ROOM_SERVICE_AVAILABLE",
- "routableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "salon": "YES",
- "sauna": "YES",
- "scuba": "YES",
- "selfParking": "SELF_PARKING_AVAILABLE",
- "seniorHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "serviceArea": {
- "places": [
- "string"
]
}, - "serviceAreaPlaces": [
- {
- "name": "string",
- "type": "POSTAL_CODE"
}
], - "services": [
- "string"
], - "smokeFreeProperty": "YES",
- "snorkeling": "YES",
- "socialHour": "YES",
- "spa": "YES",
- "specialities": [
- "string"
], - "tableService": "YES",
- "takeoutHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "tennis": "YES",
- "thermalPool": "YES",
- "ticketAvailability": "IN_STOCK",
- "ticketPriceRange": {
- "currencyCode": "string",
- "maxValue": "string",
- "minValue": "string"
}, - "ticketSaleDateTime": "2019-08-24T14:15:22Z",
- "time": {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}, - "timeZoneUtcOffset": "string",
- "timezone": "string",
- "tollFreePhone": "string",
- "treadmill": "YES",
- "ttyPhone": "string",
- "turndownService": "YES",
- "twitterHandle": "string",
- "uberLink": {
- "presentation": "BUTTON",
- "text": "string"
}, - "valetParking": "VALET_PARKING_AVAILABLE",
- "validThrough": "2019-08-24T14:15:22Z",
- "vendingMachine": "YES",
- "venueName": "string",
- "wadingPool": "YES",
- "wakeUpCalls": "YES",
- "walkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "waterPark": "YES",
- "waterSkiing": "YES",
- "watercraft": "WATERCRAFT_RENTALS",
- "waterslide": "YES",
- "wavePool": "YES",
- "websiteUrl": {
- "preferDisplayUrl": true,
}, - "weightMachine": "YES",
- "wheelchairAccessible": "YES",
- "wifiAvailable": "WIFI_AVAILABLE",
- "workRemote": true,
- "yearEstablished": 1000,
- "yearLastRenovated": 1000,
- "yextDisplayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextDropoffCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextPickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextRoutableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextWalkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}
}
}
Entity Language Profiles: List
Retrieve Language Profiles for an Entity
NOTE:
- Responses will contain resolved values for embedded fields
- If the
fields
parameter is unspecified, responses will contain the full entity profile for the requested language
path Parameters
accountId required | string >= 0 characters |
entityId required | string >= 0 characters The external ID of the requested Entity |
query Parameters
v required | string >= 0 characters A date in |
entityTypes | string >= 0 characters Comma-separated list of Entity types to filter on. Example: Should be from the following types:
OR the API name of a custom entity type. |
fields | string >= 0 characters Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., |
format | string >= 0 characters Default: "markdown" Present if and only if at least one field is of type "Rich Text." Valid values:
|
languageCodes | string >= 0 characters The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve |
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "profiles": [
- {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "entityType": "string",
- "folderId": "string",
- "id": "string",
- "labels": [
- "string"
], - "language": "string",
- "timestamp": "string",
- "uid": "string"
}, - "name": "string",
- "address": {
- "city": "string",
- "countryCode": "string",
- "extraDescription": "string",
- "line1": "string",
- "line2": "string",
- "postalCode": "string",
- "region": "string",
- "sublocality": "string"
}, - "acceptingNewPatients": true,
- "acceptsReservations": true,
- "accessHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "additionalHoursText": "string",
- "additionalPromotingLocations": [
- "string"
], - "addressHidden": true,
- "admittingHospitals": [
- "string"
], - "adultPool": "YES",
- "ageRange": {
- "maxValue": 0,
- "minValue": 0
}, - "airportShuttle": "AIRPORT_SHUTTLE_AVAILABLE",
- "airportTransfer": "YES",
- "allInclusive": "ALL_INCLUSIVE_RATES_AVAILABLE",
- "alternateNames": [
- "string"
], - "alternatePhone": "string",
- "androidAppUrl": "string",
- "answer": "string",
- "associations": [
- "string"
], - "attire": "UNSPECIFIED",
- "babysittingOffered": "YES",
- "baggageStorage": "YES",
- "bar": "YES",
- "beachAccess": "YES",
- "beachFrontProperty": "YES",
- "bicycles": "BICYCLE_RENTALS",
- "bios": {
- "ids": [
- "string"
], - "label": "string"
}, - "boutiqueStores": "YES",
- "brands": [
- "string"
], - "breakfast": "BREAKFAST_AVAILABLE",
- "brunchHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "businessCenter": "YES",
- "calendars": {
- "ids": [
- "string"
], - "label": "string"
}, - "carRental": "YES",
- "casino": "YES",
- "categoryIds": [
- "string"
], - "catsAllowed": "YES",
- "certifications": [
- "string"
], - "checkInTime": "14:15:22Z",
- "checkOutTime": "14:15:22Z",
- "classificationRating": "string",
- "closed": true,
- "concierge": "YES",
- "conditionsTreated": [
- "string"
], - "convenienceStore": "YES",
- "covidMessaging": "string",
- "covidTestingAppointmentRequired": true,
- "covidTestingDriveThroughSite": true,
- "covidTestingIsFree": true,
- "covidTestingPatientRestrictions": true,
- "covidTestingReferralRequired": true,
- "covidTestingSiteInstructions": "string",
- "covidVaccineAppointmentRequired": true,
- "covidVaccineDriveThroughSite": true,
- "covidVaccinePatientRestrictions": true,
- "covidVaccineReferralRequired": true,
- "covidVaccineSiteInstructions": "string",
- "covidVaccinesOffered": [
- "PFIZER"
], - "currencyExchange": "YES",
- "customKeywords": [
- "string"
], - "datePosted": "2019-08-24",
- "degrees": [
- "ANP"
], - "deliveryHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "description": "stringstri",
- "displayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "doctorOnCall": "YES",
- "dogsAllowed": "YES",
- "driveThroughHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "dropoffCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "educationList": [
- {
- "institutionName": "string",
- "type": "FELLOWSHIP",
- "yearCompleted": 1900
}
], - "electricChargingStation": "YES",
- "elevator": "YES",
- "ellipticalMachine": "YES",
- "emails": [
- "user@example.com"
], - "employmentType": "FULL_TIME",
- "eventStatus": "SCHEDULED",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookVanityUrl": "string",
- "fax": "string",
- "firstName": "string",
- "firstPartyReviewPage": "string",
- "fitnessCenter": "FITNESS_CENTER_AVAILABLE",
- "floorCount": 0,
- "freeWeights": "YES",
- "frequentlyAskedQuestions": [
- {
- "answer": "string",
- "question": "string"
}
], - "frontDesk": "FRONT_DESK_AVAILABLE",
- "fullyVaccinatedStaff": true,
- "gameRoom": "YES",
- "gender": "UNSPECIFIED",
- "geomodifier": "string",
- "giftShop": "YES",
- "golf": "YES",
- "googleAttributes": { },
- "googleMyBusinessLabels": [
- "string"
], - "googlePlaceId": "string",
- "happyHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "hiringOrganization": "string",
- "holidayHoursConversationEnabled": true,
- "horsebackRiding": "YES",
- "hotTub": "YES",
- "hours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "housekeeping": "HOUSEKEEPING_AVAILABLE",
- "impressum": "string",
- "indoorPoolCount": 0,
- "instagramHandle": "string",
- "insuranceAccepted": [
- "string"
], - "iosAppUrl": "string",
- "isClusterPrimary": true,
- "isFreeEvent": true,
- "isoRegionCode": "string",
- "keywords": [
- "string"
], - "kidFriendly": "YES",
- "kidsClub": "YES",
- "kidsStayFree": "YES",
- "kitchenHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "labels": [
- "string"
], - "languages": [
- "string"
], - "lastName": "string",
- "laundry": "FULL_SERVICE",
- "lazyRiver": "YES",
- "lifeguard": "YES",
- "linkedLocation": "string",
- "localPhone": "string",
- "localShuttle": "YES",
- "locatedIn": "string",
- "location": {
- "existingLocation": "string",
- "externalLocation": "string"
}, - "locationType": "LOCATION",
- "logo": {
- "description": "string",
- "details": "string",
}, - "mainPhone": "string",
- "massage": "YES",
- "maxAgeOfKidsStayFree": 0,
- "maxNumberOfKidsStayFree": 0,
- "mealsServed": [
- "BREAKFAST"
], - "meetingRoomCount": 0,
- "menuUrl": {
- "preferDisplayUrl": true,
}, - "menus": {
- "ids": [
- "string"
], - "label": "string"
}, - "middleName": "string",
- "mobilePhone": "string",
- "mobilityAccessible": "YES",
- "nightclub": "YES",
- "npi": "string",
- "nudgeEnabled": true,
- "officeName": "string",
- "onlineServiceHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "ALIPAY"
], - "performers": [
- "string"
], - "petsAllowed": "PETS_WELCOME",
- "photoGallery": [
- {
- "description": "string",
- "details": "string",
}
], - "pickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "pickupHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "priceRange": "UNSPECIFIED",
- "primaryConversationContact": "string",
- "privateBeach": "YES",
- "privateCarService": "PRIVATE_CAR_SERVICE",
- "productLists": {
- "ids": [
- "string"
], - "label": "string"
}, - "products": [
- "string"
], - "questionsAndAnswers": true,
- "rankTrackingEnabled": true,
- "rankTrackingFrequency": "WEEKLY",
- "rankTrackingQueryTemplates": [
- "KEYWORD"
], - "rankTrackingSites": [
- "GOOGLE_DESKTOP"
], - "reservationUrl": {
- "preferDisplayUrl": true,
}, - "restaurantCount": 0,
- "reviewGenerationUrl": "string",
- "reviewResponseConversationEnabled": true,
- "roomCount": 0,
- "roomService": "ROOM_SERVICE_AVAILABLE",
- "routableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "salon": "YES",
- "sauna": "YES",
- "scuba": "YES",
- "selfParking": "SELF_PARKING_AVAILABLE",
- "seniorHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "serviceArea": {
- "places": [
- "string"
]
}, - "serviceAreaPlaces": [
- {
- "name": "string",
- "type": "POSTAL_CODE"
}
], - "services": [
- "string"
], - "smokeFreeProperty": "YES",
- "snorkeling": "YES",
- "socialHour": "YES",
- "spa": "YES",
- "specialities": [
- "string"
], - "tableService": "YES",
- "takeoutHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
]
}
}, - "tennis": "YES",
- "thermalPool": "YES",
- "ticketAvailability": "IN_STOCK",
- "ticketPriceRange": {
- "currencyCode": "string",
- "maxValue": "string",
- "minValue": "string"
}, - "ticketSaleDateTime": "2019-08-24T14:15:22Z",
- "time": {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}, - "timeZoneUtcOffset": "string",
- "timezone": "string",
- "tollFreePhone": "string",
- "treadmill": "YES",
- "ttyPhone": "string",
- "turndownService": "YES",
- "twitterHandle": "string",
- "uberLink": {
- "presentation": "BUTTON",
- "text": "string"
}, - "valetParking": "VALET_PARKING_AVAILABLE",
- "validThrough": "2019-08-24T14:15:22Z",
- "vendingMachine": "YES",
- "venueName": "string",
- "wadingPool": "YES",
- "wakeUpCalls": "YES",
- "walkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "waterPark": "YES",
- "waterSkiing": "YES",
- "watercraft": "WATERCRAFT_RENTALS",
- "waterslide": "YES",
- "wavePool": "YES",
- "websiteUrl": {
- "preferDisplayUrl": true,
}, - "weightMachine": "YES",
- "wheelchairAccessible": "YES",
- "wifiAvailable": "WIFI_AVAILABLE",
- "workRemote": true,
- "yearEstablished": 1000,
- "yearLastRenovated": 1000,
- "yextDisplayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextDropoffCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextPickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextRoutableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "yextWalkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}
}
]
}
}
Entity Language Profiles: List All
Retrieve a list of Language Profiles for Entities within an account
NOTE:
- Responses will contain resolved values for embedded fields
- If the
fields
parameter is unspecified, responses will contain the full entity profile for the requested language
path Parameters
accountId required | string >= 0 characters |
query Parameters
v required | string >= 0 characters A date in | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
entityTypes | string >= 0 characters Comma-separated list of Entity types to filter on. Example: Should be from the following types:
OR the API name of a custom entity type. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | string >= 0 characters Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filter | string >= 0 characters This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is Basic Filter Structure The filter object at its core consists of a matcher, a field, and an argument. For example, in the following filter JSON:
Combining Multiple Filters Multiple filters can be combined into one object using combinators. For example, the following filter JSON combines multiple filters using the combinator
Filter Negation Certain filter types may be negated. For example:
This can also be written more simply with a
Filter Complement You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something.
Addressing Subfields Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called
While filtering, subfields may be addressed using the "dot" notation.
Fields that are nested deeper may be addressed using dot notation, as well. For example, if Field Support Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field TEXT The
BOOLEAN The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.
STRUCT The STRUCT filter type is supported for compound fields with subfields. *e.g.,
OPTION The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values. *e.g.,
PHONE The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for
INTEGER, FLOAT, DATE, DATETIME, and TIME These filter types are strictly ordered -- therefore, they support the following matchers:
LIST OF TEXT Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the
LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME
LIST OF STRUCT Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type.
For example, if
will match if any field in the list has an HOURS By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.
Filtering by Dates and Times Time zones The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities. To search in local time, simply provide the date or time without any zone: To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: Date and time types In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter:
would match all start times in the year 2018. The same logic would apply for a month ( These types also work with ordered searches. For example:
would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a "Now" and Date Math Instead of providing a static date or time, you can also use In order to search for a future or past time relative to It is also possible to add or subtract time from a static date or datetime. Simply add You can also convert date and time types to other types. For example, to convert the datetime Filtering Across an Entity It is possible to search for a specific text string across all fields of an entity by using the
Examples The following filter will match against entities that:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | string >= 0 characters Default: "markdown" Present if and only if at least one field is of type "Rich Text." Valid values:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
languageCodes | string >= 0 characters The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | number multiple of 1 <= 50 Default: "10" Number of results to return. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset | number multiple of 1 Default: "0" Number of results to skip. Used to page through results.
Cannot be used together with For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pageToken | string >= 0 characters If a response to a previous request contained the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortBy | string >= 0 characters A list of fields and sort directions to order results by. Each ordering in the list should be in the format For example, to order by |
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "count": 0,
- "pageToken": "string",
- "profileLists": [
- {
- "profiles": [
- {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "entityType": "string",
- "folderId": "string",
- "id": "string",
- "labels": [
- "string"
], - "language": "string",
- "timestamp": "string",
- "uid": "string"
}, - "name": "string",
- "address": {
- "city": "string",
- "countryCode": "string",
- "extraDescription": "string",
- "line1": "string",
- "line2": "string",
- "postalCode": "string",
- "region": "string",
- "sublocality": "string"
}, - "acceptingNewPatients": true,
- "acceptsReservations": true,
- "accessHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- { }
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}
}, - "additionalHoursText": "string",
- "additionalPromotingLocations": [
- "string"
], - "addressHidden": true,
- "admittingHospitals": [
- "string"
], - "adultPool": "YES",
- "ageRange": {
- "maxValue": 0,
- "minValue": 0
}, - "airportShuttle": "AIRPORT_SHUTTLE_AVAILABLE",
- "airportTransfer": "YES",
- "allInclusive": "ALL_INCLUSIVE_RATES_AVAILABLE",
- "alternateNames": [
- "string"
], - "alternatePhone": "string",
- "androidAppUrl": "string",
- "answer": "string",
- "associations": [
- "string"
], - "attire": "UNSPECIFIED",
- "babysittingOffered": "YES",
- "baggageStorage": "YES",
- "bar": "YES",
- "beachAccess": "YES",
- "beachFrontProperty": "YES",
- "bicycles": "BICYCLE_RENTALS",
- "bios": {
- "ids": [
- "string"
], - "label": "string"
}, - "boutiqueStores": "YES",
- "brands": [
- "string"
], - "breakfast": "BREAKFAST_AVAILABLE",
- "brunchHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- { }
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}
}, - "businessCenter": "YES",
- "calendars": {
- "ids": [
- "string"
], - "label": "string"
}, - "carRental": "YES",
- "casino": "YES",
- "categoryIds": [
- "string"
], - "catsAllowed": "YES",
- "certifications": [
- "string"
], - "checkInTime": "14:15:22Z",
- "checkOutTime": "14:15:22Z",
- "classificationRating": "string",
- "closed": true,
- "concierge": "YES",
- "conditionsTreated": [
- "string"
], - "convenienceStore": "YES",
- "covidMessaging": "string",
- "covidTestingAppointmentRequired": true,
- "covidTestingDriveThroughSite": true,
- "covidTestingIsFree": true,
- "covidTestingPatientRestrictions": true,
- "covidTestingReferralRequired": true,
- "covidTestingSiteInstructions": "string",
- "covidVaccineAppointmentRequired": true,
- "covidVaccineDriveThroughSite": true,
- "covidVaccinePatientRestrictions": true,
- "covidVaccineReferralRequired": true,
- "covidVaccineSiteInstructions": "string",
- "covidVaccinesOffered": [
- "PFIZER"
], - "currencyExchange": "YES",
- "customKeywords": [
- "string"
], - "datePosted": "2019-08-24",
- "degrees": [
- "ANP"
], - "deliveryHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- { }
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}
}, - "description": "stringstri",
- "displayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "doctorOnCall": "YES",
- "dogsAllowed": "YES",
- "driveThroughHours": {
- "friday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "holidayHours": [
- {
- "date": "2019-08-24",
- "isClosed": true,
- "isRegularHours": true,
- "openIntervals": [
- { }
]
}
], - "monday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "reopenDate": "2019-08-24",
- "saturday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "sunday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}