Yext Knowledge Manager API
The Knowledge Manager API from Yext — 30 operation(s) for knowledge manager.
Yext Knowledge Manager API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Knowledge Manager. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 58 operations across 30 paths, and defines 68 schemas. It is described by OpenAPI 3.0.0, at version 2.0.
Requests are made against a single base URL, https://api.yextapis.com/v2.
58 operations
30 paths
68 schemas
9 DELETE27 GET10 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Yext Knowledge Manager API declares
2 security schemes
for authenticating requests.
An API key is passed in the query as api_key (api_key).
An API key is passed in the header as api-key (api-key).
By default, every request must be authenticated.
Paths & Operations 58
Across 30 paths, the API surfaces 58 operations — 9 DELETE, 27 GET, 10 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
Knowledge Manager 58
GET
/accounts/{accountId}/entities
Entities: List
POST
/accounts/{accountId}/entities
Entities: Create
GET
/accounts/{accountId}/entities/{entityId}
Entities: Get
PUT
/accounts/{accountId}/entities/{entityId}
Entities: Update
DELETE
/accounts/{accountId}/entities/{entityId}
Entities: Delete
GET
/accounts/{accountId}/entityprofiles/{entityId}
Entity Language Profiles: List
GET
/accounts/{accountId}/entityprofiles
Entity Language Profiles: List All
GET
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Get
PUT
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Upsert
DELETE
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Delete
GET
/accounts/{accountId}/locations
Locations (Legacy): List
POST
/accounts/{accountId}/locations
Locations (Legacy): Create
GET
/accounts/{accountId}/locationsearch
Locations (Legacy): Search
GET
/accounts/{accountId}/locations/{locationId}
Locations (Legacy): Get
PUT
/accounts/{accountId}/locations/{locationId}
Locations (Legacy): Update
GET
/accounts/{accountId}/folders
Folders: List
GET
/accounts/{accountId}/menus
Menus: List
POST
/accounts/{accountId}/menus
Menus: Create
GET
/accounts/{accountId}/menus/{listId}
Menus: Get
PUT
/accounts/{accountId}/menus/{listId}
Menus: Update
DELETE
/accounts/{accountId}/menus/{listId}
Menus: Delete
GET
/accounts/{accountId}/bios
Bios: List
POST
/accounts/{accountId}/bios
Bios: Create
GET
/accounts/{accountId}/bios/{listId}
Bios: Get
PUT
/accounts/{accountId}/bios/{listId}
Bios: Update
DELETE
/accounts/{accountId}/bios/{listId}
Bios: Delete
GET
/accounts/{accountId}/products
Products: List
POST
/accounts/{accountId}/products
Products: Create
GET
/accounts/{accountId}/products/{listId}
Products: Get
PUT
/accounts/{accountId}/products/{listId}
Products: Update
DELETE
/accounts/{accountId}/products/{listId}
Products: Delete
GET
/accounts/{accountId}/events
Events (Legacy): List
POST
/accounts/{accountId}/events
Events (Legacy): Create
GET
/accounts/{accountId}/events/{listId}
Events (Legacy): Get
PUT
/accounts/{accountId}/events/{listId}
Events (Legacy): Update
DELETE
/accounts/{accountId}/events/{listId}
Events (Legacy): Delete
GET
/categories
Categories: List
GET
/googlefields
Google Fields: List
GET
/accounts/{accountId}/customfields
Custom Fields: List
POST
/accounts/{accountId}/customfields
Custom Fields: Create
GET
/accounts/{accountId}/customfields/{customFieldId}
Custom Fields: Get
PUT
/accounts/{accountId}/customfields/{customFieldId}
Custom Fields: Update
DELETE
/accounts/{accountId}/customfields/{customFieldId}
Custom Fields: Delete
GET
/accounts/{accountId}/locations/{locationId}/profiles
Language Profiles (Legacy): List
GET
/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
Language Profiles (Legacy): Get
PUT
/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
Language Profiles (Legacy): Upsert
DELETE
/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
Language Profiles (Legacy): Delete
GET
/accounts/{accountId}/assets
Assets: List
POST
/accounts/{accountId}/assets
Assets: Create
GET
/accounts/{accountId}/assets/{assetId}
Assets: Get
PUT
/accounts/{accountId}/assets/{assetId}
Assets: Update
DELETE
/accounts/{accountId}/assets/{assetId}
Assets: Delete
POST
/accounts/{accountId}/suggestions
Suggestion: Upsert
GET
/accounts/{accountId}/suggestions
Suggestions: List
POST
/accounts/{accountId}/suggestions/cancel/{suggestionUid}
Suggestion: Cancel
GET
/accounts/{accountId}/suggestions/{suggestionUid}
Suggestion: Get
PUT
/accounts/{accountId}/suggestions/comment/{suggestionUid}
Suggestion: Comment
PUT
/accounts/{accountId}/suggestions/action/{suggestionUid}
Suggestion: Action
Schemas 68
The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Entity-2 (267 properties), Location (139 properties), Validation (14 properties), SuggestionRead (12 properties). Each schema is shown below with its type and property counts.
Folders
object
3 properties
EntityTypes
string
NextPageToken
string
This field is only included if there is an additional page of data to display. To retrieve the next page of data, pass this field's value as the pageToken para…
Duration
object
Product duration.
2 properties
LocationType
string
HealthcareProfessionalWrite
BioEcl_Section
Translation
object
2 properties
Photos
array
List of up to 5 photos.
MenuItem
ProductItem
UpdateSuggestion
object
4 properties
Assignee
object
Object containing information about who the suggestion is assigned to. Omitted if suggestion is unassigned.
2 properties
ResponseError
object
4 properties
RestaurantWrite
Attachment
object
Attachment on a Comment on a Suggestion
2 properties
HotelWrite
Bio
Validation
object
A Custom Field validation object, describing validation rules when a Custom Field value is set or updated.
14 properties
ResponseMetaWithError
EventItem
ContentListCost
object
6 properties
Event
EntityWrite
object
1 property
JobWrite
FieldUpdate
object
7 properties
1 required
Category
object
7 properties
CommonEclDefinitions_Photo
object
4 properties
Section
SuggestedContentWrite
object
1 property
ContentListCostOption
object
3 properties
Commenter
object
Provides information about the user/system responsible for creating the comment.
3 properties
BaseEcl
object
7 properties
BaseEclItem
object
3 properties
Photo
object
8 properties
EventEcl_Section
AssetUsage
object
2 properties
1 required
SuggestionRead
object
12 properties
Option
object
3 properties
HealthcareFacilityWrite
Entity-2
object
267 properties
Location
object
139 properties
EntityFieldSuggestionRead
object
3 properties
AtmWrite
EntityFieldSuggestionWrite
object
An object containing information about a suggestion for a single field on a single entity. Only valid if the suggestion is for a field on a single entity.
2 properties
2 required
EntityWrite-2
object
The Entity which the suggestion is being made to. In Upsert requests, one of entity.id or entity.uid must be included, to identify the entity.
3 properties
PageToken
string
Pass this value into the next request as the pageToken parameter to retrieve the next page of data. If the response of a request contains the last page of data…
GoogleCategory
object
3 properties
UpsertSuggestion
object
1 property
1 required
EventWrite
Field
GoogleOption
object
2 properties
BaseEclSection
object
3 properties
Product
Calories
object
3 properties
Source
object
Provides information about the user/system responsible for creating the suggestion.
4 properties
AssetForEntities
object
5 properties
1 required
Comment-2
object
A comment on a Suggestion.
4 properties
Asset
object
9 properties
5 required
LocationWrite
FaqWrite
Approver
object
Provides information about the user/system responsible for approving/rejecting the suggestion. Only included if the suggestion has been approved or rejected.
2 properties
EntityRead
object
The Entity information for the suggestion.
6 properties
BioItem
GoogleField
object
4 properties
ProductEcl_Section
ResponseMeta
object
1 property
Menu
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yext 12
Other APIs Yext publishes across the network.
Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Analytics API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API API
Yext Domains API
Yext Health Check API
Yext Licenses API
Yext Listings API
#Knowledge Manager