Entities: List
Retrieve a list of Entities within an account
NOTE
- If the
v
parameter is20240221
or later: returned entities replace thecategoryIds
field with thecategories
field.
path Parameters
accountId required | string >= 0 characters |
query Parameters
v required | string >= 0 characters A date in | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
convertMarkdownToHTML | string >= 0 characters Optional parameter to return fields of type Markdown as HTML.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
convertRichTextToHTML | string >= 0 characters Optional parameter to return fields of type Rich Text as HTML.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 "Legacy Rich Text." Valid values:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
languages | string >= 0 characters Comma-separated list of language codes. When present, the system will return Entities that have profiles in one or more of the provided languages. For each Location, only the first available profile from the provided list of languages will be returned. The keyword | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resolvePlaceholders | boolean Default: "false" Optional parameter to resolve all embedded fields in a Location object response.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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,
- "entities": [
- {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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
},
}
], - "pageToken": "string"
}
}
Entities: Create
Create a new Entity
NOTE:
- If the
v
parameter is before20181129
: the 201 response contains the created Entity'sid
- If the
v
parameter is on or after20181129
: the 201 response contains the created Entity in its entirety - If the
v
parameter is20240221
or later: returned Entity replaces thecategoryIds
field with thecategories
field.
path Parameters
accountId required | string >= 0 characters |
query Parameters
entityType required | string >= 0 characters The type of entity to be created. Should be one of the following:
OR the API name of a custom entity type. |
v required | string >= 0 characters A date in |
format | string >= 0 characters Default: "markdown" The formatting language used to parse rich text field values. Present and required if an only if the request contains a field with type "Rich Text." Valid values:
|
stripUnsupportedFormats | boolean Optional parameter to strip unsupported formats in rich text fields. When this parameter is included, the unsupported formats in rich text fields will be stripped and saved as plain text; otherwise if this parameter is not included, unsupported formats will return an error. |
templateFields | string >= 0 characters Comma-separated list of top-level fields to apply from the template. If provided, only the fields specified will be applied to the entity. Ignored if |
templateId | string >= 0 characters The external ID of the template to apply to the entity NOTE: Some fields that are part of the provided template but not present in the API will be applied - e.g. Linked Accounts |
header Parameters
Update-Operation-Id | string >= 0 characters The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation |
Request Body schema: application/json
The entity to be created
EntityType | string This is used only to filter the fields below and should NOT be included in any API calls.
If create, specify the entity type in the query parameter. If update, specify the entity type
in the request body in the |
object Contains the metadata about the entity. | |
name | string [ 0 .. 5000 ] characters Cannot Include:
|
object Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an | |
object Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
additionalHoursText | string [ 0 .. 255 ] characters Additional information about hours that does not fit in |
alternateNames | Array of strings unique [ items [ 0 .. 100 ] characters ] Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description:
|
alternatePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
alternateWebsites | Array of strings <uri> unique [ items <uri > [ 0 .. 255 ] characters ] Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description:
|
Array of objects unique Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. | |
appleBusinessDescription | string [ 0 .. 500 ] characters The business description to be sent to Apple |
appleBusinessId | string >= 0 characters ^\d*\.?\d*$ The ID associated with an individual Business Folder in your Apple account |
appleCompanyId | string >= 0 characters ^\d*\.?\d*$ The ID associated with your Apple account. Numerical values only |
object The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
categories | object Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. |
categoryIds | Array of strings[ items >= 0 characters ] Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. |
closed | boolean Indicates whether the entity is closed |
customKeywords | Array of strings unique [ items [ 0 .. 100 ] characters ] Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. |
description | string [ 10 .. 15000 ] characters A description of the entity Cannot Include:
|
object Coordinates where the map pin for the entity should be displayed, as provided by you | |
object Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
object Coordinates of the drop-off area for the entity, as provided by you | |
facebookAbout | string [ 0 .. 255 ] characters A description of the entity to be used in the "About You" section on Facebook |
object Designates the Facebook Call-to-Action button text and value Valid contents of
| |
object The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
facebookDescriptor | string [ 3 .. 75 ] characters Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include:
|
facebookName | string >= 0 characters The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. |
facebookOverrideCity | string >= 0 characters The city to be displayed on this entity's Facebook profile |
facebookPageUrl | string >= 0 characters URL for the entity's Facebook Page. Valid formats:
where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. |
facebookParentPageId | string [ 0 .. 65 ] characters The Facebook Page ID of this entity's brand page if in a brand page location structure |
object The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
facebookStoreId | string >= 0 characters The Store ID used for this entity in a brand page location structure |
facebookVanityUrl | string [ 0 .. 50 ] characters The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. |
facebookWebsiteOverride | string <uri> >= 0 characters The URL you would like to submit to Facebook in place of the one given in |
fax | string >= 0 characters Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's |
object Information about the entity's Featured Message | |
Array of objects unique A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. | |
geomodifier | string >= 0 characters Provides additional information on where the entity can be found (e.g., |
googleAttributes | object The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is
NOTE: The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. |
object The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels | |
googleMyBusinessLabels | Array of strings unique [ items [ 0 .. 50 ] characters ] Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description:
|
googlePlaceId | string >= 0 characters The unique identifier of this entity on Google Maps. |
object The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
googleWebsiteOverride | string <uri> >= 0 characters The URL you would like to submit to Google Business Profile in place of the one given in For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. |
holidayHoursConversationEnabled | boolean Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity |
object Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
impressum | string [ 0 .. 2000 ] characters A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. |
isoRegionCode | string >= 0 characters The ISO 3166-2 region code for the entity Yext will determine the entity's code and update |
keywords | Array of strings unique [ items [ 0 .. 100 ] characters ] Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description:
|
labels | Array of strings[ items >= 0 characters ] The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. NOTE: You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. |
landingPageUrl | string <uri> >= 0 characters The URL of this entity's Landing Page that was created with Yext Pages |
localPhone | string >= 0 characters Must be a valid, non-toll-free phone number, based on the country specified in |
locatedIn | string For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. |
locationType | string Enum: "LOCATION" "HEALTHCARE_FACILITY" "HEALTHCARE_PROFESSIONAL" "ATM" "RESTAURANT" "HOTEL" Indicates the entity's type, if it is not an event |
object An image of the entity's logo Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
mainPhone | string >= 0 characters The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
mobilePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
nudgeEnabled | boolean Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity |
Array of objects NOTE: The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description:
| |
object Coordinates of where consumers can be picked up at the entity, as provided by you | |
priceRange | string Enum: "UNSPECIFIED" "ONE" "TWO" "THREE" "FOUR" he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) |
primaryConversationContact | string >= 0 characters ID of the user who is the primary Knowledge Assistant contact for the entity |
questionsAndAnswers | boolean Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity |
Array of objects unique Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. | |
rankTrackingEnabled | boolean Indicates whether Rank Tracking is enabled |
rankTrackingFrequency | string Enum: "WEEKLY" "MONTHLY" "QUARTERLY" How often we send search queries to track your search performance |
rankTrackingQueryTemplates | Array of strings unique Items Enum: "KEYWORD" "KEYWORD_ZIP" "KEYWORD_CITY" "KEYWORD_IN_CITY" "KEYWORD_NEAR_ME" "KEYWORD_CITY_STATE" The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. |
rankTrackingSites | Array of strings unique Items Enum: "GOOGLE_DESKTOP" "GOOGLE_MOBILE" "BING_DESKTOP" "BING_MOBILE" "YAHOO_DESKTOP" "YAHOO_MOBILE" The search engines that we will use to track your performance |
reviewResponseConversationEnabled | boolean Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity |
object Destination coordinates to use for driving directions to the entity, as provided by you | |
timezone | string >= 0 characters The timezone of the entity, in the standard |
tollFreePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
ttyPhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
object Destination coordinates to use for walking directions to the entity, as provided by you | |
object Information about the website for this entity |
Responses
Request samples
- Payload
{- "EntityType": "atm",
- "meta": {
- "countryCode": "string",
- "folderId": "string",
- "id": "string",
- "labels": [
- "string"
], - "language": "string"
}, - "name": "string",
- "address": {
- "city": "string",
- "countryCode": "string",
- "extraDescription": "string",
- "line1": "string",
- "line2": "string",
- "postalCode": "string",
- "region": "string",
- "sublocality": "string"
}, - "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",
- "alternateNames": [
- "string"
], - "alternatePhone": "string",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "string",
- "categories": { },
- "categoryIds": [
- "string"
], - "closed": true,
- "customKeywords": [
- "string"
], - "description": "stringstri",
- "displayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "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
}, - "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "string",
- "facebookVanityUrl": "string",
- "fax": "string",
- "frequentlyAskedQuestions": [
- {
- "answer": "string",
- "question": "string"
}
], - "geomodifier": "string",
- "googleAttributes": { },
- "googleMyBusinessLabels": [
- "string"
], - "googlePlaceId": "string",
- "holidayHoursConversationEnabled": true,
- "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"
}
]
}
}, - "impressum": "string",
- "isoRegionCode": "string",
- "keywords": [
- "string"
], - "labels": [
- "string"
], - "localPhone": "string",
- "locatedIn": "string",
- "locationType": "LOCATION",
- "logo": {
- "description": "string",
- "details": "string",
}, - "mainPhone": "string",
- "mobilePhone": "string",
- "nudgeEnabled": true,
- "photoGallery": [
- {
- "description": "string",
- "details": "string",
}
], - "pickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "priceRange": "UNSPECIFIED",
- "primaryConversationContact": "string",
- "questionsAndAnswers": true,
- "rankTrackingEnabled": true,
- "rankTrackingFrequency": "WEEKLY",
- "rankTrackingQueryTemplates": [
- "KEYWORD"
], - "rankTrackingSites": [
- "GOOGLE_DESKTOP"
], - "reviewResponseConversationEnabled": true,
- "routableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "timezone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "walkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "websiteUrl": {
- "preferDisplayUrl": true,
}
}
Response samples
- 201
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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
},
}
}
Entities: Get
Retrieve information for an Entity with a given ID
NOTE
- If the
v
parameter is20240221
or later: returned entities replace thecategoryIds
field with thecategories
field.
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 |
convertMarkdownToHTML | string >= 0 characters Optional parameter to return fields of type Markdown as HTML.
|
convertRichTextToHTML | string >= 0 characters Optional parameter to return fields of type Rich Text as HTML.
|
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 "Legacy Rich Text." Valid values:
|
resolvePlaceholders | boolean Default: "false" Optional parameter to resolve all embedded fields in a Location object response.
|
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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
},
}
}
Entities: Update
Update the Entity with the given ID
NOTE
- If the
v
parameter is20240221
or later: returned Entity replaces thecategoryIds
field with thecategories
field.
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 |
format | string >= 0 characters Default: "markdown" The formatting language used to parse rich text field values. Present and required if an only if the request contains a field with type "Rich Text." Valid values:
|
stripUnsupportedFormats | boolean Optional parameter to strip unsupported formats in rich text fields. When this parameter is included, the unsupported formats in rich text fields will be stripped and saved as plain text; otherwise if this parameter is not included, unsupported formats will return an error. |
templateFields | string >= 0 characters Comma-separated list of top-level fields to apply from the template. If provided, only the fields specified will be applied to the entity. Ignored if |
templateId | string >= 0 characters The external ID of the template to apply to the entity NOTE: Some fields that are part of the provided template but not present in the API will be applied - e.g. Linked Accounts |
header Parameters
Update-Operation-Id | string >= 0 characters The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation |
Request Body schema: application/json
Information to update on the entity
EntityType | string This is used only to filter the fields below and should NOT be included in any API calls.
If create, specify the entity type in the query parameter. If update, specify the entity type
in the request body in the |
object Contains the metadata about the entity. | |
name | string [ 0 .. 5000 ] characters Cannot Include:
|
object Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an | |
object Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
additionalHoursText | string [ 0 .. 255 ] characters Additional information about hours that does not fit in |
alternateNames | Array of strings unique [ items [ 0 .. 100 ] characters ] Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description:
|
alternatePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
alternateWebsites | Array of strings <uri> unique [ items <uri > [ 0 .. 255 ] characters ] Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description:
|
Array of objects unique Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. | |
appleBusinessDescription | string [ 0 .. 500 ] characters The business description to be sent to Apple |
appleBusinessId | string >= 0 characters ^\d*\.?\d*$ The ID associated with an individual Business Folder in your Apple account |
appleCompanyId | string >= 0 characters ^\d*\.?\d*$ The ID associated with your Apple account. Numerical values only |
object The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
categories | object Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. |
categoryIds | Array of strings[ items >= 0 characters ] Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. |
closed | boolean Indicates whether the entity is closed |
customKeywords | Array of strings unique [ items [ 0 .. 100 ] characters ] Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. |
description | string [ 10 .. 15000 ] characters A description of the entity Cannot Include:
|
object Coordinates where the map pin for the entity should be displayed, as provided by you | |
object Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
object Coordinates of the drop-off area for the entity, as provided by you | |
facebookAbout | string [ 0 .. 255 ] characters A description of the entity to be used in the "About You" section on Facebook |
object Designates the Facebook Call-to-Action button text and value Valid contents of
| |
object The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
facebookDescriptor | string [ 3 .. 75 ] characters Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include:
|
facebookName | string >= 0 characters The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. |
facebookOverrideCity | string >= 0 characters The city to be displayed on this entity's Facebook profile |
facebookPageUrl | string >= 0 characters URL for the entity's Facebook Page. Valid formats:
where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. |
facebookParentPageId | string [ 0 .. 65 ] characters The Facebook Page ID of this entity's brand page if in a brand page location structure |
object The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
facebookStoreId | string >= 0 characters The Store ID used for this entity in a brand page location structure |
facebookVanityUrl | string [ 0 .. 50 ] characters The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. |
facebookWebsiteOverride | string <uri> >= 0 characters The URL you would like to submit to Facebook in place of the one given in |
fax | string >= 0 characters Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's |
object Information about the entity's Featured Message | |
Array of objects unique A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. | |
geomodifier | string >= 0 characters Provides additional information on where the entity can be found (e.g., |
googleAttributes | object The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is
NOTE: The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. |
object The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels | |
googleMyBusinessLabels | Array of strings unique [ items [ 0 .. 50 ] characters ] Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description:
|
googlePlaceId | string >= 0 characters The unique identifier of this entity on Google Maps. |
object The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
googleWebsiteOverride | string <uri> >= 0 characters The URL you would like to submit to Google Business Profile in place of the one given in For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. |
holidayHoursConversationEnabled | boolean Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity |
object Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
impressum | string [ 0 .. 2000 ] characters A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. |
isoRegionCode | string >= 0 characters The ISO 3166-2 region code for the entity Yext will determine the entity's code and update |
keywords | Array of strings unique [ items [ 0 .. 100 ] characters ] Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description:
|
labels | Array of strings[ items >= 0 characters ] The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. NOTE: You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. |
landingPageUrl | string <uri> >= 0 characters The URL of this entity's Landing Page that was created with Yext Pages |
localPhone | string >= 0 characters Must be a valid, non-toll-free phone number, based on the country specified in |
locatedIn | string For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. |
locationType | string Enum: "LOCATION" "HEALTHCARE_FACILITY" "HEALTHCARE_PROFESSIONAL" "ATM" "RESTAURANT" "HOTEL" Indicates the entity's type, if it is not an event |
object An image of the entity's logo Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
mainPhone | string >= 0 characters The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
mobilePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
nudgeEnabled | boolean Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity |
Array of objects NOTE: The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description:
| |
object Coordinates of where consumers can be picked up at the entity, as provided by you | |
priceRange | string Enum: "UNSPECIFIED" "ONE" "TWO" "THREE" "FOUR" he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) |
primaryConversationContact | string >= 0 characters ID of the user who is the primary Knowledge Assistant contact for the entity |
questionsAndAnswers | boolean Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity |
Array of objects unique Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. | |
rankTrackingEnabled | boolean Indicates whether Rank Tracking is enabled |
rankTrackingFrequency | string Enum: "WEEKLY" "MONTHLY" "QUARTERLY" How often we send search queries to track your search performance |
rankTrackingQueryTemplates | Array of strings unique Items Enum: "KEYWORD" "KEYWORD_ZIP" "KEYWORD_CITY" "KEYWORD_IN_CITY" "KEYWORD_NEAR_ME" "KEYWORD_CITY_STATE" The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. |
rankTrackingSites | Array of strings unique Items Enum: "GOOGLE_DESKTOP" "GOOGLE_MOBILE" "BING_DESKTOP" "BING_MOBILE" "YAHOO_DESKTOP" "YAHOO_MOBILE" The search engines that we will use to track your performance |
reviewResponseConversationEnabled | boolean Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity |
object Destination coordinates to use for driving directions to the entity, as provided by you | |
timezone | string >= 0 characters The timezone of the entity, in the standard |
tollFreePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
ttyPhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
object Destination coordinates to use for walking directions to the entity, as provided by you | |
object Information about the website for this entity |
Responses
Request samples
- Payload
{- "EntityType": "atm",
- "meta": {
- "countryCode": "string",
- "folderId": "string",
- "id": "string",
- "labels": [
- "string"
], - "language": "string"
}, - "name": "string",
- "address": {
- "city": "string",
- "countryCode": "string",
- "extraDescription": "string",
- "line1": "string",
- "line2": "string",
- "postalCode": "string",
- "region": "string",
- "sublocality": "string"
}, - "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",
- "alternateNames": [
- "string"
], - "alternatePhone": "string",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "string",
- "categories": { },
- "categoryIds": [
- "string"
], - "closed": true,
- "customKeywords": [
- "string"
], - "description": "stringstri",
- "displayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "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
}, - "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "string",
- "facebookVanityUrl": "string",
- "fax": "string",
- "frequentlyAskedQuestions": [
- {
- "answer": "string",
- "question": "string"
}
], - "geomodifier": "string",
- "googleAttributes": { },
- "googleMyBusinessLabels": [
- "string"
], - "googlePlaceId": "string",
- "holidayHoursConversationEnabled": true,
- "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"
}
]
}
}, - "impressum": "string",
- "isoRegionCode": "string",
- "keywords": [
- "string"
], - "labels": [
- "string"
], - "localPhone": "string",
- "locatedIn": "string",
- "locationType": "LOCATION",
- "logo": {
- "description": "string",
- "details": "string",
}, - "mainPhone": "string",
- "mobilePhone": "string",
- "nudgeEnabled": true,
- "photoGallery": [
- {
- "description": "string",
- "details": "string",
}
], - "pickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "priceRange": "UNSPECIFIED",
- "primaryConversationContact": "string",
- "questionsAndAnswers": true,
- "rankTrackingEnabled": true,
- "rankTrackingFrequency": "WEEKLY",
- "rankTrackingQueryTemplates": [
- "KEYWORD"
], - "rankTrackingSites": [
- "GOOGLE_DESKTOP"
], - "reviewResponseConversationEnabled": true,
- "routableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "timezone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "walkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "websiteUrl": {
- "preferDisplayUrl": true,
}
}
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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
},
}
}
Entities: Delete
Delete the Entity with the given ID
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 |
header Parameters
Update-Operation-Id | string >= 0 characters The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation |
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "id": "string"
}
Entity Language Profiles: List
Retrieve Language Profiles for an Entity
- If the
v
parameter is before20190103
: by default, returned alternate Language Profiles includegoogleAttributes
andcategoryIds
fields - If the
v
parameter is20190103
or later: by default, returned alternate Language Profiles do not includegoogleAttributes
andcategoryIds
fields. However, these fields can still be retrieved if therendered
parameter in the request is set totrue
. - If the
v
parameter is20240221
or later: returned alternate Language Profiles replace thecategoryIds
field with thecategories
field.
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 |
convertMarkdownToHTML | string >= 0 characters Optional parameter to return fields of type Markdown as HTML.
|
convertRichTextToHTML | string >= 0 characters Optional parameter to return fields of type Rich Text as HTML.
|
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 "Legacy 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 |
rendered | string >= 0 characters Default: "false"
|
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "profiles": [
- {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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:
- If the
v
parameter is before20190103
: by default, returned alternate Language Profiles includegoogleAttributes
andcategoryIds
fields - If the
v
parameter is20190103
or later: by default, returned alternate Language Profiles do not includegoogleAttributes
andcategoryIds
fields. However, these fields can still be retrieved if therendered
parameter in the request is set totrue
. - If the
v
parameter is20240221
or later: returned alternate Language Profiles replace thecategoryIds
field with thecategories
field.
path Parameters
accountId required | string >= 0 characters |
query Parameters
v required | string >= 0 characters A date in | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
convertMarkdownToHTML | string >= 0 characters Optional parameter to return fields of type Markdown as HTML.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
convertRichTextToHTML | string >= 0 characters Optional parameter to return fields of type Rich Text as HTML.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 "Legacy 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rendered | string >= 0 characters Default: "false"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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
}
]
}, - "thursday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "tuesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}, - "wednesday": {
- "isClosed": true,
- "openIntervals": [
- {
- "end": null,
- "start": null
}
]
}
}, - "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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": 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
}
]
}
}, - "hiringOrganization": "string",
- "holidayHoursConversationEnabled": true,
- "horsebackRiding": "YES",
- "hotTub": "YES",
- "hours": {
- "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
}
]
}
}, - "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": 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
}
]
}
}, - "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": 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
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "performers": [
- "string"
], - "petsAllowed": "PETS_WELCOME",
- "photoGallery": [
- {
- "description": "string",
- "details": "string",
}
], - "pickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "pickupHours": {
- "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
}
]
}
}, - "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": 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
}
]
}
}, - "serviceArea": {
- "places": [
- "string"
]
}, - "serviceAreaPlaces": [
- {
- "name": "string",
- "googlePlaceId": "string",
- "type": "POSTAL_CODE"
}
], - "services": [
- "string"
], - "smokeFreeProperty": "YES",
- "snorkeling": "YES",
- "socialHour": "YES",
- "spa": "YES",
- "specialities": [
- "string"
], - "tableService": "YES",
- "takeoutHours": {
- "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
}
]
}
}, - "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: Get
Retrieve a Language Profile for an Entity
NOTE:
- If the
v
parameter is before20190103
: by default, returned alternate Language Profiles includegoogleAttributes
andcategoryIds
fields - If the
v
parameter is20190103
or later: by default, returned alternate Language Profiles do not includegoogleAttributes
andcategoryIds
fields. However, these fields can still be retrieved if therendered
parameter in the request is set totrue
. - If the
v
parameter is20240221
or later: returned alternate Language Profiles replace thecategoryIds
field with thecategories
field.
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 |
convertMarkdownToHTML | string >= 0 characters Optional parameter to return fields of type Markdown as HTML.
|
convertRichTextToHTML | string >= 0 characters Optional parameter to return fields of type Rich Text as HTML.
|
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 "Legacy Rich Text." Valid values:
|
rendered | boolean Default: "false"
|
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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: Upsert
Add a language profile
NOTE
- If the
v
parameter is20240221
or later: returned Language Profile replaces thecategoryIds
field with thecategories
field.
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 profile that the user wishes to create or update |
query Parameters
v required | string >= 0 characters A date in |
header Parameters
Update-Operation-Id | string >= 0 characters The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation |
Request Body schema: application/json
The entity profile to create
EntityType | string This is used only to filter the fields below and should NOT be included in any API calls.
If create, specify the entity type in the query parameter. If update, specify the entity type
in the request body in the |
object Contains the metadata about the entity. | |
name | string [ 0 .. 5000 ] characters Cannot Include:
|
object Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an | |
object Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
additionalHoursText | string [ 0 .. 255 ] characters Additional information about hours that does not fit in |
alternateNames | Array of strings unique [ items [ 0 .. 100 ] characters ] Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description:
|
alternatePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
alternateWebsites | Array of strings <uri> unique [ items <uri > [ 0 .. 255 ] characters ] Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description:
|
Array of objects unique Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. | |
appleBusinessDescription | string [ 0 .. 500 ] characters The business description to be sent to Apple |
appleBusinessId | string >= 0 characters ^\d*\.?\d*$ The ID associated with an individual Business Folder in your Apple account |
appleCompanyId | string >= 0 characters ^\d*\.?\d*$ The ID associated with your Apple account. Numerical values only |
object The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
categories | object Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. |
categoryIds | Array of strings[ items >= 0 characters ] Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. |
closed | boolean Indicates whether the entity is closed |
customKeywords | Array of strings unique [ items [ 0 .. 100 ] characters ] Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. |
description | string [ 10 .. 15000 ] characters A description of the entity Cannot Include:
|
object Coordinates where the map pin for the entity should be displayed, as provided by you | |
object Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
object Coordinates of the drop-off area for the entity, as provided by you | |
facebookAbout | string [ 0 .. 255 ] characters A description of the entity to be used in the "About You" section on Facebook |
object Designates the Facebook Call-to-Action button text and value Valid contents of
| |
object The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
facebookDescriptor | string [ 3 .. 75 ] characters Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include:
|
facebookName | string >= 0 characters The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. |
facebookOverrideCity | string >= 0 characters The city to be displayed on this entity's Facebook profile |
facebookPageUrl | string >= 0 characters URL for the entity's Facebook Page. Valid formats:
where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. |
facebookParentPageId | string [ 0 .. 65 ] characters The Facebook Page ID of this entity's brand page if in a brand page location structure |
object The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
facebookStoreId | string >= 0 characters The Store ID used for this entity in a brand page location structure |
facebookVanityUrl | string [ 0 .. 50 ] characters The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. |
facebookWebsiteOverride | string <uri> >= 0 characters The URL you would like to submit to Facebook in place of the one given in |
fax | string >= 0 characters Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's |
object Information about the entity's Featured Message | |
Array of objects unique A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. | |
geomodifier | string >= 0 characters Provides additional information on where the entity can be found (e.g., |
googleAttributes | object The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is
NOTE: The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. |
object The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels | |
googleMyBusinessLabels | Array of strings unique [ items [ 0 .. 50 ] characters ] Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description:
|
googlePlaceId | string >= 0 characters The unique identifier of this entity on Google Maps. |
object The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
googleWebsiteOverride | string <uri> >= 0 characters The URL you would like to submit to Google Business Profile in place of the one given in For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. |
holidayHoursConversationEnabled | boolean Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity |
object Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of
| |
impressum | string [ 0 .. 2000 ] characters A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. |
isoRegionCode | string >= 0 characters The ISO 3166-2 region code for the entity Yext will determine the entity's code and update |
keywords | Array of strings unique [ items [ 0 .. 100 ] characters ] Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description:
|
labels | Array of strings[ items >= 0 characters ] The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. NOTE: You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. |
landingPageUrl | string <uri> >= 0 characters The URL of this entity's Landing Page that was created with Yext Pages |
localPhone | string >= 0 characters Must be a valid, non-toll-free phone number, based on the country specified in |
locatedIn | string For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. |
locationType | string Enum: "LOCATION" "HEALTHCARE_FACILITY" "HEALTHCARE_PROFESSIONAL" "ATM" "RESTAURANT" "HOTEL" Indicates the entity's type, if it is not an event |
object An image of the entity's logo Supported Aspect Ratios:
NOTE: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. | |
mainPhone | string >= 0 characters The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
mobilePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
nudgeEnabled | boolean Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity |
Array of objects NOTE: The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description:
| |
object Coordinates of where consumers can be picked up at the entity, as provided by you | |
priceRange | string Enum: "UNSPECIFIED" "ONE" "TWO" "THREE" "FOUR" he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) |
primaryConversationContact | string >= 0 characters ID of the user who is the primary Knowledge Assistant contact for the entity |
questionsAndAnswers | boolean Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity |
Array of objects unique Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. | |
rankTrackingEnabled | boolean Indicates whether Rank Tracking is enabled |
rankTrackingFrequency | string Enum: "WEEKLY" "MONTHLY" "QUARTERLY" How often we send search queries to track your search performance |
rankTrackingQueryTemplates | Array of strings unique Items Enum: "KEYWORD" "KEYWORD_ZIP" "KEYWORD_CITY" "KEYWORD_IN_CITY" "KEYWORD_NEAR_ME" "KEYWORD_CITY_STATE" The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. |
rankTrackingSites | Array of strings unique Items Enum: "GOOGLE_DESKTOP" "GOOGLE_MOBILE" "BING_DESKTOP" "BING_MOBILE" "YAHOO_DESKTOP" "YAHOO_MOBILE" The search engines that we will use to track your performance |
reviewResponseConversationEnabled | boolean Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity |
object Destination coordinates to use for driving directions to the entity, as provided by you | |
timezone | string >= 0 characters The timezone of the entity, in the standard |
tollFreePhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
ttyPhone | string >= 0 characters Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's |
object Destination coordinates to use for walking directions to the entity, as provided by you | |
object Information about the website for this entity |
Responses
Request samples
- Payload
{- "EntityType": "atm",
- "meta": {
- "countryCode": "string",
- "folderId": "string",
- "id": "string",
- "labels": [
- "string"
], - "language": "string"
}, - "name": "string",
- "address": {
- "city": "string",
- "countryCode": "string",
- "extraDescription": "string",
- "line1": "string",
- "line2": "string",
- "postalCode": "string",
- "region": "string",
- "sublocality": "string"
}, - "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",
- "alternateNames": [
- "string"
], - "alternatePhone": "string",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "string",
- "categories": { },
- "categoryIds": [
- "string"
], - "closed": true,
- "customKeywords": [
- "string"
], - "description": "stringstri",
- "displayCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "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
}, - "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "string",
- "facebookVanityUrl": "string",
- "fax": "string",
- "frequentlyAskedQuestions": [
- {
- "answer": "string",
- "question": "string"
}
], - "geomodifier": "string",
- "googleAttributes": { },
- "googleMyBusinessLabels": [
- "string"
], - "googlePlaceId": "string",
- "holidayHoursConversationEnabled": true,
- "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"
}
]
}
}, - "impressum": "string",
- "isoRegionCode": "string",
- "keywords": [
- "string"
], - "labels": [
- "string"
], - "localPhone": "string",
- "locatedIn": "string",
- "locationType": "LOCATION",
- "logo": {
- "description": "string",
- "details": "string",
}, - "mainPhone": "string",
- "mobilePhone": "string",
- "nudgeEnabled": true,
- "photoGallery": [
- {
- "description": "string",
- "details": "string",
}
], - "pickupCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "priceRange": "UNSPECIFIED",
- "primaryConversationContact": "string",
- "questionsAndAnswers": true,
- "rankTrackingEnabled": true,
- "rankTrackingFrequency": "WEEKLY",
- "rankTrackingQueryTemplates": [
- "KEYWORD"
], - "rankTrackingSites": [
- "GOOGLE_DESKTOP"
], - "reviewResponseConversationEnabled": true,
- "routableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "timezone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "walkableCoordinate": {
- "latitude": -90,
- "longitude": -180
}, - "websiteUrl": {
- "preferDisplayUrl": true,
}
}
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": {
- "meta": {
- "accountId": "string",
- "countryCode": "string",
- "createdTimestamp": "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",
- "appleActionLinks": [
- {
- "appName": "string",
- "category": "BOOK_TRAVEL",
}
], - "appleBusinessDescription": "string",
- "appleBusinessId": "string",
- "appleCompanyId": "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",
- "categories": { },
- "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",
- "facebookAbout": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookDescriptor": "string",
- "facebookName": "string",
- "facebookOverrideCity": "string",
- "facebookPageUrl": "string",
- "facebookParentPageId": "string",
- "facebookStoreId": "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"
}
]
}
}, - "operatingCountries": [
- "AD"
], - "orderUrl": {
- "preferDisplayUrl": true,
}, - "organizerEmail": "user@example.com",
- "organizerName": "string",
- "organizerPhone": "string",
- "outdoorPoolCount": 0,
- "parking": "PARKING_AVAILABLE",
- "paymentOptions": [
- "AFTERPAY"
], - "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",
- "googlePlaceId": "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: Delete
Delete a language profile
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 profile that the user wishes to delete |
query Parameters
v required | string >= 0 characters A date in |
header Parameters
Update-Operation-Id | string >= 0 characters The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation |
Responses
Response samples
- 200
- 400
{- "meta": {
- "uuid": "string"
}, - "response": { }
}