Yext Suggestions API
The Suggestions API from Yext — 2 operation(s) for suggestions.
Yext Suggestions API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Suggestions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 2 paths, and defines 4 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Yext Suggestions 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 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PartnerSuggestion (6 properties), SuggestionAcceptBody (2 properties), PartnerSuggestionList (2 properties), ResponseErrorNew (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yext 12
Other APIs Yext publishes across the network.