Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yext Live API API

The Live API API from Yext — 21 operation(s) for live api.

Yext Live API API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Live API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 22 operations across 21 paths, and defines 34 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.

22 operations 21 paths 34 schemas 1 DELETE18 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Yext Live API 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 22

Across 21 paths, the API surfaces 22 operations — 1 DELETE, 18 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Live API 22
GET
/accounts/{accountId}/entities
Entities: List
listEntities 14 params → 200400
GET
/accounts/{accountId}/entities/{entityId}
Entities: Get
getEntity 7 params → 200400
GET
/accounts/{accountId}/entities/geosearch
Entities: GeoSearch
geoSearchEntities 15 params → 200400
GET
/accounts/{accountId}/entityschema/{entityType}/{entityId}/{languageCode}
Entities Schema: Get
getEntitySchema 5 params → 200default
GET
/accounts/{accountId}/entityprofiles/{entityId}/{languageCode}
Entity Language Profiles: Get
getLanguageProfile 8 params → 200400
GET
/accounts/{accountId}/entityprofiles/{entityId}
Entity Language Profiles: List
listLanguageProfiles 9 params → 200400
GET
/accounts/{accountId}/entityprofiles
Entity Language Profiles: List All
listAllLanguageProfiles 13 params → 200400
GET
/accounts/{accountId}/menus/{listId}
Menus: Get
getMenus 3 params → 200default
GET
/accounts/{accountId}/bios/{listId}
Bios: Get
getBios 3 params → 200default
GET
/accounts/{accountId}/products/{listId}
Products: Get
getProducts 3 params → 200default
GET
/accounts/{accountId}/events/{listId}
Events (Legacy): Get
getEvents 3 params → 200default
GET
/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}
Language Profiles (Legacy): Get
getLanguageProfiles 5 params → 200default
GET
/accounts/{accountId}/locations/{locationId}/profiles
Language Profiles (Legacy): List
listLocationLanguageProfiles 4 params → 200default
GET
/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}/schema
Language Profiles Schema (Legacy): Get
getLanguageProfilesSchema 4 params → 200default
GET
/accounts/{accountId}/locations/{locationId}
Locations (Legacy): Get
getLocation 4 params → 200default
GET
/accounts/{accountId}/locations
Locations (Legacy): List
locationsList 8 params → 200default
GET
/accounts/{accountId}/locations/{locationId}/schema
Locations Schema (Legacy): Get
getLocationSchema 3 params → 200default
GET
/accounts/{accountId}/locations/geosearch
Locations (Legacy): GeoSearch
geoSearch 12 params → 200default
POST
/accounts/{accountId}/createQuestion
Question: Create
createQuestion 2 params body → 200default
POST
/accounts/{accountId}/reviewSubmission
Review: Create
createReview 2 params body → 202default
PUT
/accounts/{accountId}/reviewSubmission/{apiIdentifier}
Review: Update
updateReview 3 params body → 202default
DELETE
/accounts/{accountId}/reviewSubmission/{apiIdentifier}
Review: Delete
deleteReview 3 params → 202default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Location (139 properties), CreateReview (13 properties), UpdateReview (11 properties), LocationSchema (9 properties). Each schema is shown below with its type and property counts.

Photo
object
4 properties
Menu
EventEcl_Section
Bio
LocationSchema
object
9 properties
Geo
object
If location provided in geosearch cannot be geocoded, this field will be set to null.
9 properties 9 required
ResponseMetaWithError
ContentListCost
object
6 properties
Event
EventItem
Location
object
139 properties
EntitySchema
object
8 properties
Duration
object
Product duration.
2 properties
UpdateReview
object
11 properties
LocationType
string
BioEcl_Section
BaseEclSection
object
3 properties
QuestionRequest
object
7 properties 5 required
LocationDistance
object
3 properties
CreateReview
object
13 properties 4 required
Product
Calories
object
3 properties
Section
Photos
array
List of up to 5 photos.
MenuItem
ProductItem
Photo-2
object
8 properties
BioItem
ProductEcl_Section
ResponseMeta
object
1 property
ContentListCostOption
object
3 properties
BaseEclItem
object
3 properties
ResponseError
object
4 properties
BaseEcl
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-live-api-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 Knowledge Manager API
Yext Licenses API