Categories: List
Get available Categories.
All Locations are required to have an associated Category to assist with organization and search. Yext provides a hierarchy of business categories for this purpose, exposed by this API.
query Parameters
| v required | string A date in |
| language | string Only categories that apply to this language will be returned. Valid values: ISO 639-1 language codes Example: en |
| country | string Only categories that apply in this country will be returned. Valid values: ISO 3166-1 alpha-2 country codes Example: US |
| entityType | string Enum: "atm" "event" "healthcareFacility" "healthcareProfessional" "location" "restaurant" Only categories that apply to the specified entity type will be returned. |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": [
- {
- "id": "string",
- "name": "string",
- "fullName": "string",
- "selectable": true,
- "parentId": "string",
- "entityTypeAvailability": {
- "mode": "string",
- "entityTypes": [
- "string"
]
}, - "countryAvailability": {
- "mode": "string",
- "countryCodes": [
- "string"
]
}
}
]
}Google Fields: List
Use the Google Fields endpoint to retrieve a complete list of Google's location attributes for each business category. This list includes attributes that may not apply to all Locations in an account. The set of attributes available to a Location depends on its primary business category and country. You can view and edit the attributes of Locations in the googleAttributes Location field.
NOTE:
- 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.
- Only one of
entityIdorclientCategoryIdcan be specified at a time.
query Parameters
| language | string The language code corresponding to the language in which the user would like to retrieve the Google Fields. Only categories that apply to this language will be returned. |
| clientCategoryId | string A category id for the business or a Google category ID that, if specified, will filter the result to only include any Google Fields that the provided id maps to. |
| entityId | string The external ID of an entity that, if specified, will filter the result to only include any Google Fields that the provided entity has access to. NOTE: The |
| countryCode | string The two-character ISO 3166-1 country code, if specified, will filter the result to only include any Google Fields that are eligible for that country. |
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "items": [
- {
- "categoryId": "string",
- "clientCategoryIds": [
- "string"
], - "fields": [
- {
- "label": "string",
- "id": "string",
- "group": "string",
- "options": [
- {
- "id": "string",
- "label": "string"
}
]
}
]
}
]
}
}