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 Accounts API

The Accounts API from Yext — 8 operation(s) for accounts.

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

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

This API exposes 8 operations across 8 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://cdn.yextapis.com/v2, https://us.yextevents.com, https://aws.us.yextevents.com, https://eu.yextevents.com, https://gcp.eu.yextevents.com.

8 operations 8 paths 27 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Yext Accounts API declares 3 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). It accepts HTTP bearer tokens (JWT) (jwt).

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Accounts 8
GET
/accounts/{accountId}/search/autocomplete
Universal Search: Autocomplete
autocomplete 7 params → 200400
GET
/accounts/{accountId}/search/query
Universal Search: Query
query 18 params → 200400
GET
/accounts/{accountId}/search/vertical/autocomplete
Vertical Search: Autocomplete
verticalAutocomplete 8 params → 200400
GET
/accounts/{accountId}/search/vertical/query
Vertical Search: Query
verticalQuery 24 params → 200400
GET
/accounts/{accountId}/search/filtersearch
Vertical Search: Filter Search
filtersearch 9 params → 200400
POST
/accounts/{accountId}/search/generateAnswer
Answer: Generate
generateAnswer 4 params body → 200400
POST
/accounts/{accountId}/chat/{botId}/message
Chat: Message Endpoint
message 3 params body → 200default
POST
/accounts/me/events
Analytics Events
sendEvents body → 202429default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are SendEventsRequestBody (25 properties), Notes (6 properties), Module (5 properties), ResponseError (4 properties). Each schema is shown below with its type and property counts.

verticalConfigId
string
String key that uniquely identifies the vertical.
Modules
array
List of results for each vertical that was relevant to the query, returned in the order of relevance.
Module
object
The results and metadata pertaining to a single vertical relevant to the user's query.
5 properties
LocationBias
object
Information about geographical location biases used in the search.
4 properties
FailedVerticals
array
Contains error information when one or more verticals fail to return results.
ResponseError
object
4 properties
resultCount
integer
The number of entities within the vertical that are relevant to the user's query.
ResponseMetaWithError
Results
array
The individual entity results that contain metadata about the entity as well as the fully rendered profiles.
SearchIntents
array
Items in array each represent a particular intent expressed in the user's query. Example: NEARME
HighlightedValue
object
Highlighting instructions for a field value, containing the original value of the field and all sections of the value that should be highlighted.
2 properties
queryId
string
UUID for the query
SpellCheck
object
SpellCheck information that may correct the user's query.
3 properties
filter
object
The filter, in the filter format, that was applied. For example: "cexampleFieldId": { $eq": "Search" }
Facets
object
3 properties
AppliedQueryFilters
array
A list of the filters that were inferred from the user's query and applied at search time.
FailedVertical
object
4 properties
GenerateAnswerRequest
object
3 properties 3 required
Entity
object
4 properties
businessId
integer
ID of the account associated with this Search experience
DirectAnswer
object
Information that is estimated to directly answer the question of the query.
3 properties
ResponseMeta
object
1 property
Notes
object
6 properties
Error
array
List of errors and warnings.
conversationId
string
A ULID representing the conversation between the user and the chatbot.
Message
object
3 properties
SendEventsRequestBody
object
Represents an event for analytics purposes.
25 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-accounts-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Administrative API
Yext Analytics API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API
Yext Domains API
Yext Health Check API
Yext Knowledge Manager API
Yext Licenses API
Yext Listings API
Where this information came from

This is an independent, third-party profile of Yext Accounts 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.