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

The Connectors API from Yext — 5 operation(s) for connectors.

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

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

This API exposes 5 operations across 5 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.

5 operations 5 paths 4 schemas 1 GET4 POST

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 Connectors 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 5

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

Connectors 5
POST
/accounts/{accountId}/connectors/{connectorId}/pushData
Connectors: Push Data
pushData 5 params body → 200default
POST
/accounts/{accountId}/connectors/{connectorId}/trigger
Connectors: Trigger
triggerConnector 5 params → 200default
GET
/accounts/{accountId}/connectors/{connectorId}/runs/{runUid}
Connectors: Get Run
getConnectorRun 4 params → 200default
POST
/accounts/{accountId}/connectors/{connectorId}/runs/{runUid}/approve
Connectors: Approve Run
approveRun 4 params → 200default
POST
/accounts/{accountId}/connectors/{connectorId}/runs/{runUid}/cancel
Connectors: Cancel Run
cancelRun 4 params → 200default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ConnectorRunResults (5 properties), ResponseError (4 properties), ResponseMeta (1 property). Each schema is shown below with its type and property counts.

ResponseMetaWithError
ResponseMeta
object
1 property
ResponseError
object
4 properties
ConnectorRunResults
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-connectors-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 Content API API
Yext Domains API
Yext Health Check API
Yext Knowledge Manager API
Yext Licenses API
Yext Listings API