Yext Administrative API API
NOTE: You need a sandbox account to test your Administrative API integration. Contact your Account Manager to have one created for you.
Yext Administrative 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 Administrative API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 20 operations across 19 paths, and defines 27 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 Administrative 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 20
Across 19 paths, the API surfaces 20 operations — 10 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
NOTE: You need a sandbox account to test your Administrative API integration. Contact your Account Manager to have one created for you.
Schemas 27
The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Entity (267 properties), Location (139 properties), AddRequest (15 properties), SubAccountService (10 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.