Getting started with the Yext API involves four steps: creating a developer account, creating an app in the Developer Console, retrieving your API key, and sending your first API request.
Create a Developer Account
Create a Yext developer account to get started. A developer account is a trial account that provides immediate access to four entities, so you can start working with Yext APIs. Activity in a developer account never affects production data.
A Yext subscription is required to use the Listings, Analytics, Reviews, Social, and User endpoints.
If you're a Yext Partner, Developer Accounts don't apply to your dashboard setup. Contact your Client Success Manager, who can create a Yext Sandbox Account for you instead.
Create an App in the Developer Console
- Log in to your developer account or Yext account.
- Click Developer > Developer Console in the navigation bar.
- Click + Add an App in the top right corner.
- Enter a name for your app and click Create App.
- Click the API Credentials tab, add the appropriate permissions for your app, and click Save.
Retrieve Your API Key
After you create your app and assign its permissions, find your API key in the API Keys section of the page. Click the eye icon to reveal the key, then copy it somewhere easily accessible for your next request.
Send Your First API Request
Open your browser and go to one of the following URLs, replacing YOUR_API_KEY with your app's API key and YYYYMMDD with today's date:
Production:
GET https://api.yextapis.com/v2/accounts/me/entities?api_key=YOUR_API_KEY&v=YYYYMMDDSandbox:
GET https://sbx-api.yextapis.com/v2/accounts/me/entities?api_key=YOUR_API_KEY&v=YYYYMMDD