Yext
Connect Yext to manage locations and other entities, sync listings, answer reviews, publish social posts, and report on search and analytics.
You paste one value into PopMCP: the API key of a small app you make in Yext's Developer Console. PopMCP finds out whether your account is in the US or the EU, and if the key also reaches sub-accounts, you choose which to connect.
- Setup time
- 3 min
- Auth
- API credentials
- API base URL
- https://api.yextapis.com/v2
- Rate limits
- An app gets 5,000 requests an hour on the Management API, with 1,000 an hour for Analytics and for Agreements, and 100,000 an hour on the Content Delivery API. Short bursts are limited separately. Connections through PopMCP's own Yext app share that app's hourly budget, so they are held to fair use.
Before you begin
- A Yext account, and access to its Developer Console. If Developer is not in your navigation bar, ask whoever administers your Yext account
- No review or approval is needed for an app you make for your own account
- A few tools need that product on your subscription: Live API and Content Endpoints, Search, Chat, Pages, Scout. Reseller agreements work for Yext partners only
Get your credentials
Open the Developer Console
Sign in to Yext. In the navigation bar, open Developer, then Developer Console. Every app in your account is listed here. Yext makes the key on an app, so PopMCP gets an app of its own.
Developer Console
No apps yet
Add an app to get an API key.
Add an app
Click + Add an App in the top right corner. Name it something you will recognise, like PopMCP, and click Create App. It stays private to your account, which is all this needs.
Developer Console
Choose what the app can do
Open the API Credentials tab. Under API permissions, add each API you want the AI to use and set it to Read/Write, or Read-only to keep it from changing anything there. Most people want the entities, listings, reviews, social and analytics APIs. Click Save. Content Delivery APIs are always read only. You can add more later: they start working without reconnecting.
PopMCP
API Credentials
| API | Access |
|---|---|
| Entities | Read/Write |
| Listings | Read/Write |
| Reviews | Read/Write |
| Social Posts | Read/Write |
| Analytics | Read-only |
Yext's own names for each API can differ a little from this picture.
Copy the API key
On the same tab, find the API Keys section. Click the eye icon to show the key, then copy it. The client ID and secret on the OAuth tab do not work here.
PopMCP
API Credentials
Paste the key into PopMCP and pick the account
In PopMCP, paste the key into API key and connect. PopMCP tries it in Yext's US, EU and sandbox environments and lists the accounts it reaches: your own, plus any sub-accounts if it came from a parent account. Choose which to connect. Each goes to its own workspace and stays on that account. New connections start read-only until an owner or admin allows write actions.
Connect in PopMCP
Open your workspace, choose Yext in the marketplace, and fill in the connect dialog:
| Field | What to enter |
|---|---|
| API keysecret | In Yext open Developer, then Developer Console and click + Add an App. Name it PopMCP and click Create App. On the API Credentials tab add the permissions you want and click Save, then click the eye icon beside the API key and copy it. Stored encrypted, used server-side only.Encrypted with AES-256-GCM on save and never shown again. |
PopMCP verifies the credential against Yext immediately. On success the connection flips to Verified and its MCP tools are provisioned.
Verify it worked
PopMCP marks the Yext connection Verified under your account's name, and names any common permission the app is missing. Asking the AI for an overview of your Yext account returns its locations, publishers and review average.
Troubleshooting
"Yext did not recognise this key in its US, EU or sandbox environments."
Why: The key was cut short, or it was copied from somewhere else on the page, or the app has since been deleted.
Fix: In **Developer**, **Developer Console**, open the app, go to **API Credentials**, click the eye icon beside the API key and copy it again.
"That does not look like a Yext API key."
Why: Something other than the key was pasted, such as a sentence, or the OAuth client ID or secret.
Fix: Copy the value from the **API Keys** section of the app's **API Credentials** tab.
A tool answers that this app has no permission for this API
Why: The API is not on the app, or it is only Read-only and the tool writes.
Fix: On the app's **API Credentials** tab, add that API as **Read/Write** and click **Save**. It works straight away, with no reconnecting.
The connection shows "Yext account" rather than your account's name
Why: The app has no Accounts permission, so PopMCP cannot read the name. Everything else still works.
Fix: Add the Accounts permission on the app's **API Credentials** tab.
"This Yext key cannot open account"
Why: The connection is on a sub-account the key no longer reaches.
Fix: Use a key from that account or from its parent, then reconnect.
A tool answers 404 for something you know exists
Why: The account may not have that product. Search, Chat, Pages, Scout and Content Delivery each need a subscription, and Agreements is for Yext partners.
Fix: Check the product is on your subscription with your Yext account manager.
Yext answers 429
Why: An app gets 5,000 requests an hour, 1,000 for Analytics and for Agreements, and short bursts are limited separately.
Fix: Wait as the message says. Summary tools such as `yext_get_account_overview` and `yext_summarize_reviews` use far fewer requests.