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 Administrative 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 is one of 22 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.2.0, at version 2.0.

Requests are made against a single base URL, https://api.yextapis.com/v2.

20 operations 19 paths 27 schemas 10 GET9 POST1 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 Administrative 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.

Administrative API 20

NOTE: You need a sandbox account to test your Administrative API integration. Contact your Account Manager to have one created for you.

GET
/accounts/{accountId}/availableservices
Available Services: List
listAvailableServices 2 params → 200default
POST
/accounts/{accountId}/newlocationaddrequests
Add Requests: Create (New Location)
createNewLocationAddRequest 2 params body → 200default
POST
/accounts/{accountId}/existinglocationaddrequests
Add Requests: Create (Existing Location)
createExistingLocationAddRequest 2 params body → 200default
POST
/accounts/{accountId}/existingsubaccountaddrequests
Add Requests: Create (Existing Account)
createExistingSubAccountAddRequest 2 params body → 200default
POST
/accounts/{accountId}/cancelservices
Services: Cancel (Location)
cancelServices 2 params body → 200default
POST
/accounts/{accountId}/cancelsubaccountservices
Services: Cancel (Account)
cancelSubAccountServices 2 params body → 200default
POST
/accounts/{accountId}/cancelallsubaccountservices
Services: Cancel All (Account)
cancelAllSubAccountServices 2 params body → 200default
POST
/accounts/{accountId}/processaddrequest
Add Requests: Process (Sandbox API Only)
createProcessReviewAddRequest 2 params body → 200default
GET
/accounts/{accountId}/addrequests
Add Requests: List (Location)
listAddRequests 12 params → 200default
GET
/accounts/{accountId}/addrequests/{addRequestId}
Add Requests: Get (Location)
getAddRequest 3 params → 200default
GET
/accounts/{accountId}/subaccountaddrequests
Add Requests: List (Sub-Account)
listSubAccountAddRequests 12 params → 200default
GET
/accounts/{accountId}/subaccountaddrequests/{addRequestId}
Add Requests: Get (Sub-Account)
getSubAccountAddRequest 3 params → 200default
GET
/accounts/{accountId}/services
Services: List (Location)
listServices 9 params → 200default
GET
/accounts/{accountId}/subaccountservices
Services: List (Sub-Account)
listSubAccountServices 8 params → 200default
POST
/accounts/{accountId}/createsubaccount
Accounts: Create Sub-Account
createSubAccount 2 params body → 200default
POST
/accounts/{accountId}/resourcesapplyrequests
Resources Apply Request: Create (Account)
resourcesApplyRequest 2 params body → 200default
GET
/accounts/{accountId}/resourcesapplyrequests/{requestId}
Resources Apply Request Status: Get (Account)
getResourcesApplyRequestStatus 3 params → 200default
GET
/accounts
Accounts: List
listAccounts 4 params → 200default
GET
/accounts/{accountId}
Accounts: Get
getAccount 2 params → 200default
PUT
/accounts/{accountId}
Accounts: Update
updateAccount 2 params body → 200default

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.

CreateSubAccount
object
3 properties
ResponseError
object
4 properties
ResponseMetaWithError
CancelAllSubAccountServicesRequest
object
2 properties 1 required
ExistingLocationAddRequest
object
5 properties 2 required
Service
object
10 properties
Photo
object
8 properties
SubAccountService
object
10 properties
LocationType
string
ResourcesApplyRequestResponse
object
6 properties
ProcessReviewAddRequest
object
2 properties 2 required
ResourcesApplyRequest
object
2 properties 2 required
AvailableService
object
7 properties
CreateSubAccountRequest
object
3 properties 3 required
NewLocationAddRequest
object
10 properties 4 required
ResponseMeta
object
1 property
UpdateAccount
object
2 properties
SkuQuantity
object
2 properties
SubAccountAddRequest
object
7 properties
ExistingSubAccountAddRequest
object
3 properties 2 required
Entity
object
267 properties
Account
object
9 properties
CancelSubAccountServicesRequest
object
3 properties 2 required
Source
object
This is an object containing the information about where the Resources are located. The attributes in this object include type, url and variables.
3 properties 2 required
Location
object
139 properties
CancelServicesRequest
object
4 properties 1 required
AddRequest
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-administrative-api-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts 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 Administrative 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.