How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yext Knowledge Manager API

The Knowledge Manager API from Yext — 30 operation(s) for knowledge manager.

Yext Knowledge Manager API is one of 22 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.2.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.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.yextapis.com/v2
Authentication
API Key, API Key
Resource Areas
1

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
listEntities 14 params → 200400
POST
/accounts/{accountId}/entities
Entities: Create
createEntity 8 params body → 201400
GET
/accounts/{accountId}/entities/{entityId}
Entities: Get
getEntity 8 params → 200400
PUT
/accounts/{accountId}/entities/{entityId}
Entities: Update
updateEntity 8 params body → 200400
DELETE
/accounts/{accountId}/entities/{entityId}
Entities: Delete
deleteEntity 4 params → 200400
GET
/accounts/{accountId}/entityprofiles/{entityId}
Entity Language Profiles: List
listLanguageProfiles 10 params → 200400
GET
/accounts/{accountId}/entityprofiles
Entity Language Profiles: List All
listAllLanguageProfiles 14 params → 200400
GET
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Get
getLanguageProfile 9 params → 200400
PUT
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Upsert
upsertLanguageProfile 5 params body → 200400
DELETE
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Delete
deleteLanguageProfile 5 params → 200400
GET
/accounts/{accountId}/locations
Locations (Legacy): List
getLocations 6 params → 200default
POST
/accounts/{accountId}/locations
Locations (Legacy): Create
createLocation 2 params body → 201default
GET
/accounts/{accountId}/locationsearch
Locations (Legacy): Search
searchLocations 5 params → 200default
GET
/accounts/{accountId}/locations/{locationId}
Locations (Legacy): Get
getLocation 4 params → 200default
PUT
/accounts/{accountId}/locations/{locationId}
Locations (Legacy): Update
updateLocation 3 params body → 200default
GET
/accounts/{accountId}/folders
Folders: List
getLocationFolders 4 params → 200default
GET
/accounts/{accountId}/menus
Menus: List
getMenus 4 params → 200default
POST
/accounts/{accountId}/menus
Menus: Create
createMenu 2 params body → 201default
GET
/accounts/{accountId}/menus/{listId}
Menus: Get
getMenu 3 params → 200default
PUT
/accounts/{accountId}/menus/{listId}
Menus: Update
updateMenu 3 params body → 200default
DELETE
/accounts/{accountId}/menus/{listId}
Menus: Delete
deleteMenuList 3 params → 200default
GET
/accounts/{accountId}/bios
Bios: List
getBios 4 params → 200default
POST
/accounts/{accountId}/bios
Bios: Create
createBio 2 params body → 201default
GET
/accounts/{accountId}/bios/{listId}
Bios: Get
getBio 3 params → 200default
PUT
/accounts/{accountId}/bios/{listId}
Bios: Update
updateBio 3 params body → 200default
DELETE
/accounts/{accountId}/bios/{listId}
Bios: Delete
deleteBioList 3 params → 200default
GET
/accounts/{accountId}/products
Products: List
getProducts 4 params → 200default
POST
/accounts/{accountId}/products
Products: Create
createProduct 2 params body → 201default
GET
/accounts/{accountId}/products/{listId}
Products: Get
getProduct 3 params → 200default
PUT
/accounts/{accountId}/products/{listId}
Products: Update
updateProduct 3 params body → 200default
DELETE
/accounts/{accountId}/products/{listId}
Products: Delete
deleteProductList 3 params → 200default
GET
/accounts/{accountId}/events
Events (Legacy): List
getEvents 4 params → 200default
POST
/accounts/{accountId}/events
Events (Legacy): Create
createEvent 2 params body → 201default
GET
/accounts/{accountId}/events/{listId}
Events (Legacy): Get
getEvent 3 params → 200default
PUT
/accounts/{accountId}/events/{listId}
Events (Legacy): Update
updateEvent 3 params body → 200default
DELETE
/accounts/{accountId}/events/{listId}
Events (Legacy): Delete
deleteEventList 3 params → 200default
GET
/categories
Categories: List
getBusinessCategories 4 params → 200default
GET
/googlefields
Google Fields: List
getGoogleKeywords 5 params → 200default
GET
/accounts/{accountId}/customfields
Custom Fields: List
getCustomFields 5 params → 200default
POST
/accounts/{accountId}/customfields
Custom Fields: Create
createCustomField 2 params body → 201default
GET
/accounts/{accountId}/customfields/{customFieldId}
Custom Fields: Get
getCustomField 3 params → 200default
PUT
/accounts/{accountId}/customfields/{customFieldId}
Custom Fields: Update
updateCustomField 3 params body → 200default
DELETE
/accounts/{accountId}/customfields/{customFieldId}
Custom Fields: Delete
deleteCustomField 3 params → 200default
GET
/accounts/{accountId}/locations/{locationId}/profiles
Language Profiles (Legacy): List
getLanguageProfiles 4 params → 200default
GET
/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
Language Profiles (Legacy): Get
getLocationLanguageProfile 5 params → 200default
PUT
/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
Language Profiles (Legacy): Upsert
upsertLocationLanguageProfile 5 params body → 200201default
DELETE
/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
Language Profiles (Legacy): Delete
deleteLocationLanguageProfile 4 params → 200default
GET
/accounts/{accountId}/assets
Assets: List
listAssets 6 params → 200default
POST
/accounts/{accountId}/assets
Assets: Create
createAsset 3 params body → 201default
GET
/accounts/{accountId}/assets/{assetId}
Assets: Get
getAsset 4 params → 200default
PUT
/accounts/{accountId}/assets/{assetId}
Assets: Update
updateAsset 4 params body → 200default
DELETE
/accounts/{accountId}/assets/{assetId}
Assets: Delete
deleteAsset 3 params → 200default
POST
/accounts/{accountId}/suggestions
Suggestion: Upsert
upsertSuggestion 3 params body → 200default
GET
/accounts/{accountId}/suggestions
Suggestions: List
listSuggestions 9 params → 200default
POST
/accounts/{accountId}/suggestions/cancel/{suggestionUid}
Suggestion: Cancel
cancelSuggestion 3 params → 200default
GET
/accounts/{accountId}/suggestions/{suggestionUid}
Suggestion: Get
getSuggestion 4 params → 200default
PUT
/accounts/{accountId}/suggestions/comment/{suggestionUid}
Suggestion: Comment
commentSuggestion 3 params body → 200default
PUT
/accounts/{accountId}/suggestions/action/{suggestionUid}
Suggestion: Action
updateSuggestion 4 params body → 200default

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.

Option
object
3 properties
Section
BioItem
ResponseMetaWithError
BioEcl_Section
BaseEcl
object
7 properties
Menu
ContentListCost
object
6 properties
Calories
object
3 properties
UpsertSuggestion
object
1 property 1 required
Duration
object
Product duration.
2 properties
Field
HotelWrite
AtmWrite
Attachment
object
Attachment on a Comment on a Suggestion
2 properties
ContentListCostOption
object
3 properties
AssetUsage
object
2 properties 1 required
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…
EntityFieldSuggestionRead
object
3 properties
Folders
object
3 properties
ResponseError
object
4 properties
HealthcareProfessionalWrite
BaseEclItem
object
3 properties
EventItem
LocationType
string
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
Comment-2
object
A comment on a Suggestion.
4 properties
EventEcl_Section
Assignee
object
Object containing information about who the suggestion is assigned to. Omitted if suggestion is unassigned.
2 properties
Event
Location
object
139 properties
BaseEclSection
object
3 properties
SuggestedContentWrite
object
1 property
Product
MenuItem
ResponseMeta
object
1 property
FieldUpdate
object
7 properties 1 required
Asset
object
9 properties 5 required
SuggestionRead
object
12 properties
Entity-2
object
267 properties
EntityWrite
object
1 property
GoogleOption
object
2 properties
Validation
object
A Custom Field validation object, describing validation rules when a Custom Field value is set or updated.
14 properties
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
LocationWrite
Commenter
object
Provides information about the user/system responsible for creating the comment.
3 properties
FaqWrite
CommonEclDefinitions_Photo
object
4 properties
Photos
array
List of up to 5 photos.
RestaurantWrite
ProductItem
ProductEcl_Section
HealthcareFacilityWrite
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…
Category
object
7 properties
EntityTypes
string
JobWrite
Translation
object
2 properties
GoogleCategory
object
3 properties
Source
object
Provides information about the user/system responsible for creating the suggestion.
4 properties
Photo
object
8 properties
Bio
GoogleField
object
4 properties
EventWrite
AssetForEntities
object
5 properties 1 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
UpdateSuggestion
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-knowledge-manager-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Yext Knowledge Manager API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.