Skip to main content

Yext

Yext is a digital presence platform that manages a brand's business information, such as locations, hours, and products, in a central Knowledge Graph and syncs it to publishers like Google and Facebook, alongside review and listings management. The Yext connector reads Knowledge Graph entities, locations, folders, custom fields, reviews, review invitations, listings status, publisher suggestions, duplicate listings, analytics reports, accounts, users, and roles through the Yext Management API, and can create and update entities and reply to reviews.

Yext icon

Power end-to-end data operations for your Yext API with Nexla. Our bi-directional Yext connector is purpose-built for Yext, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Yext or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Yext workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Yext Management API with the API key of an app in your Yext account. To create one:

  1. Sign in to your Yext account. If you don't have one, you can sign up for a free Yext developer account. Developer accounts are sandbox accounts with a small entity limit, and they use the Sandbox API host.

  2. Open the Developer Console, and add a new app.

  3. Give the app Management API permissions for the data you plan to use: read access to Entities, Reviews, Listings, Analytics, Users, and Account Settings, and write access to Entities and Reviews if you plan to use the destination templates.

  4. Open the app's API Credentials tab, and copy the API key. Store it securely.

You also need to know which Yext API host your account uses. Production accounts use api.yextapis.com (or the US or EU partition host, api.us.yextapis.com or api.eu.yextapis.com, if Yext told you to use one); developer accounts use the Sandbox host, sbx-api.yextapis.com. A key works only against the host of the environment it was created in.

Listings and Analytics data need the matching Yext subscriptions. On a developer account, or an account without those subscriptions, the listings and analytics templates can return no records or a permission error.

Yext API rate limits

Yext allows 5,000 requests per hour per account, plus a separate 1,000 requests per hour for Analytics, and returns HTTP 429 when a limit is reached. Templates that page through large result sets make one request per page. See Yext's API policies and conventions for details.

Authenticate​

Credentials required​

Yext app API key sent as the api_key query parameter, plus the API host (production, US/EU partition or sandbox) and account id (default 'me').

FieldRequiredSecretDescription
API KeyYesYesAPI key of a Yext app (Developer Console > app > API Credentials) with read, and for writes write, access to Entities, Reviews, Listings, Analytics, Users. Sent as api_key.
API HostYesNoYext API host for your account. api.yextapis.com works for production accounts; use the EU or US partition host if Yext told you to, or Sandbox for free developer accounts. Allowed values: Production (api.yextapis.com); Production US (api.us.yextapis.com); Production EU (api.eu.yextapis.com); Sandbox (sbx-api.yextapis.com)
Account IDYesNoYext account id used in every URL. Keep 'me' for the account that owns the API key; a partner can enter a sub-account id.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Paste the app's API key into the API Key field. Nexla sends it as the api_key query parameter on every request.

    The API key is sensitive and should be kept secure. If it is exposed, generate a new key for the app in the Yext Developer Console, and update this credential.

  4. Select the API Host for your account: Production (api.yextapis.com) for most production accounts, Production US or Production EU if Yext told you to use a partition host, or Sandbox (sbx-api.yextapis.com) for a developer or sandbox account.

  5. Keep Account ID set to me to use the account that owns the API key. Partners with sub-accounts can enter a sub-account ID instead; use the List Accounts template to find it.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by reading the account that owns the API key. Every request uses Yext API version v=20251101.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Yext connector tile, then select the credential that will be used to connect to your Yext account, and click Next; or, create a new Yext credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Yext endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say "Results are paged automatically" read every page; all other templates make a single request. Templates that need an ID, such as an entity or review ID, read that one object; use the matching list template to find the ID. In the request paths below, {base_url} is the credential's API Host and {account_id} is its Account ID.

Knowledge Graph​

List Entities

Lists every Knowledge Graph entity of every type, such as locations, events, FAQs, products, and professionals, with all of their fields. Use it for a full Knowledge Graph export.

  • Calls GET {base_url}/accounts/{account_id}/entities?v=20251101&limit=50.
  • Results are paged automatically, 50 entities per page.
  • See the Yext API reference for the response fields.

List Entities by Type

Lists the Knowledge Graph entities of the types you choose, with all of their fields. Use it when you need only stores, events, FAQs, or another type.

  • Calls GET {base_url}/accounts/{account_id}/entities?v=20251101&limit=50&entityTypes={Entity Types}.
  • Results are paged automatically, 50 entities per page.
  • Entity Types (required; default location): A comma-separated list of entity type API names, for example location or location,event. Built-in types include location, event, faq, product, healthcareProfessional, restaurant, hotel, and job; custom types use their API name.
  • See the Yext API reference for the response fields.

Get Entity

Returns one Knowledge Graph entity, such as a store, with its name, address, hours, phone, categories, custom fields, and metadata.

  • Calls GET {base_url}/accounts/{account_id}/entities/{Entity ID}?v=20251101.
  • Entity ID (required): The entity ID (the meta.id value from List Entities), for example a store number.
  • See the Yext API reference for the response fields.

List Locations (Legacy)

Lists locations from Yext's legacy Locations API, in its older format. For new flows, use List Entities by Type with the location type instead.

  • Calls GET {base_url}/accounts/{account_id}/locations?v=20251101&limit=50.
  • Results are paged automatically, 50 locations per page.
  • See the Yext API reference for the response fields.

List Folders

Lists the entity folders in the account, with each folder's ID, name, and parent folder ID. Use it to map the folderId on entities.

  • Calls GET {base_url}/accounts/{account_id}/folders?v=20251101.
  • Results are paged automatically, 1,000 folders per page.
  • See the Yext API reference for the response fields.

List Custom Fields

Lists the custom field definitions in the account, with each field's ID, name, type, options, and the entity types it applies to. Use it to interpret the c_ fields returned on entities.

  • Calls GET {base_url}/accounts/{account_id}/customfields?v=20251101&limit=1000.
  • Results are paged automatically, 1,000 fields per page.
  • See the Yext API reference for the response fields.

Reviews​

List Reviews

Lists reviews across all publishers, such as Google, Facebook, and first-party reviews, with the review ID, entity, publisher, rating, content, author, dates, status, and owner responses.

  • Calls GET {base_url}/accounts/{account_id}/reviews?v=20251101&limit=100.
  • Results are paged automatically, 100 reviews per page.
  • See the Yext API reference for the response fields.

List Reviews Updated Since

Lists the reviews that Yext last updated on or after a date, with rating, content, author, and owner responses. Use it for incremental review syncs.

  • Calls GET {base_url}/accounts/{account_id}/reviews?v=20251101&limit=100&minLastYextUpdateDate={Updated Since (YYYY-MM-DD)}.
  • Results are paged automatically, 100 reviews per page.
  • Updated Since (YYYY-MM-DD) (required; default {now-30}): Only reviews updated in Yext on or after this date, in yyyy-MM-dd format. The default, {now-30}, is 30 days ago.
  • See the Yext API reference for the response fields.

Get Review

Returns one review with its rating, content, author, publisher, status, labels, and full comment thread, including owner responses.

  • Calls GET {base_url}/accounts/{account_id}/reviews/{Review ID}?v=20251101.
  • Review ID (required): The numeric review ID. Use List Reviews to find it.
  • See the Yext API reference for the response fields.

List Review Invitations

Lists the review invitations sent by email or SMS, with the entity, contact, template, status, and the sent, opened, clicked, and responded times.

  • Calls GET {base_url}/accounts/{account_id}/reviewinvites?v=20251101.
  • Results are paged automatically, 100 invitations per page. Yext returns at most about 10,000 invitations this way.
  • See the Yext API reference for the response fields.

Listings​

List Listings

Lists the listing status for each location on each publisher, such as LIVE, WAITING_ON_YEXT, WAITING_ON_CUSTOMER, or UNAVAILABLE, with the listing URL, screenshot, and status details.

  • Calls GET {base_url}/accounts/{account_id}/listings/listings?v=20251101&limit=100.
  • Results are paged automatically, 100 listings per page.
  • See the Yext API reference for the response fields.

List Entity Listings

Lists the listing status for each entity on each publisher, for all entity types (not only locations), with status, URL, and alternate brands.

  • Calls GET {base_url}/accounts/{account_id}/listings/entitylistings?v=20251101&limit=100.
  • Results are paged automatically, 100 listings per page.
  • See the Yext API reference for the response fields.

List Listings Publishers

Lists the publishers (sites and apps) that Yext can sync listings to, with each publisher's ID, name, supported countries, and entity types.

  • Calls GET {base_url}/accounts/{account_id}/listings/publishers?v=20251101&subset={Subset}.
  • Subset (required; default RELEVANT_ONLY): RELEVANT_ONLY returns only the publishers in your subscriptions and countries; ALL returns every publisher. Options: RELEVANT_ONLY, ALL.
  • See the Yext API reference for the response fields.

List Publisher Suggestions

Lists the edits that publishers, such as Google users, have suggested for your listings, with the field, current value, suggested value, and status. Use it to review pending listing changes.

  • Calls GET {base_url}/accounts/{account_id}/listings/publishersuggestions?v=20251101.
  • Results are paged automatically, 50 suggestions per page.
  • See the Yext API reference for the response fields.

List Listing Duplicates

Lists the duplicate listings that Yext found on publishers, with location, publisher, URL, and status (such as POSSIBLE_DUPLICATE, SUPPRESSION_REQUESTED, or SUPPRESSED).

  • Calls GET {base_url}/accounts/{account_id}/listings/duplicates?v=20251101.
  • Results are paged automatically, 50 duplicates per page.
  • See the Yext API reference for the response fields.

Analytics​

Run Analytics Report

Runs a Yext analytics report for any metrics, such as PROFILE_VIEWS or LISTINGS_LIVE, broken down by the dimensions you choose over a date range, and returns one record per report row. By default it returns profile views by location.

  • Calls POST {base_url}/accounts/{account_id}/analytics/reports?v=20251101.
  • Metrics (required; default ["PROFILE_VIEWS"]): A JSON array of up to 10 metric names, for example ["PROFILE_VIEWS", "NEW_REVIEWS"]. List Analytics Metrics lists the valid names.
  • Dimensions (required; default ["LOCATION_NAMES"]): A JSON array of up to 10 dimensions, for example ["DAYS"], ["MONTHS"], or ["LOCATION_NAMES"]. Use at most one time dimension and one location dimension.
  • Start Date (YYYY-MM-DD) (required; default {now-30}): The first day of the report, in yyyy-MM-dd format. The default, {now-30}, is 30 days ago. Weekly and monthly dimensions need a start date at the start of a week or month.
  • End Date (YYYY-MM-DD) (required; default {now-2}): The day after the last day of the report (the end date is exclusive), in yyyy-MM-dd format. The default, {now-2}, is two days ago; it must not be later than the dates from Get Analytics Max Dates.
  • This template reads data; it uses POST only because Yext's report endpoint takes the report definition in the request body. Valid metric and dimension combinations depend on the metric; use List Analytics Metrics to check them.
  • See the Yext API reference for the response fields.

Review Analytics

Runs a Yext analytics report for review metrics, new reviews and average rating by default, broken down by day over a date range, and returns one record per report row.

  • Calls POST {base_url}/accounts/{account_id}/analytics/reports?v=20251101.
  • Metrics (required; default ["NEW_REVIEWS", "AVERAGE_RATING"]): A JSON array of up to 10 metric names, for example ["PROFILE_VIEWS", "NEW_REVIEWS"]. List Analytics Metrics lists the valid names.
  • Dimensions (required; default ["DAYS"]): A JSON array of up to 10 dimensions, for example ["DAYS"], ["MONTHS"], or ["LOCATION_NAMES"]. Use at most one time dimension and one location dimension.
  • Start Date (YYYY-MM-DD) (required; default {now-30}): The first day of the report, in yyyy-MM-dd format. The default, {now-30}, is 30 days ago. Weekly and monthly dimensions need a start date at the start of a week or month.
  • End Date (YYYY-MM-DD) (required; default {now-2}): The day after the last day of the report (the end date is exclusive), in yyyy-MM-dd format. The default, {now-2}, is two days ago; it must not be later than the dates from Get Analytics Max Dates.
  • This template reads data; it uses POST only because Yext's report endpoint takes the report definition in the request body. Use List Analytics Metrics to check which dimensions each review metric supports.
  • See the Yext API reference for the response fields.

List Analytics Metrics

Lists the analytics metrics available to the account, with the dimensions and filters each supports. Use it to pick valid metric and dimension names for the report templates.

  • Calls GET {base_url}/accounts/{account_id}/analytics/catalog?v=20251101.
  • See the Yext API reference for the response fields.

Get Analytics Max Dates

Returns the latest dates for which analytics data is complete (standardMaxDate and bingMaxDate). Use it to choose the end date of a report.

  • Calls GET {base_url}/accounts/{account_id}/analytics/maxdates?v=20251101.
  • See the Yext API reference for the response fields.

Accounts and users​

List Accounts

Lists the accounts the API key can access: your own account, plus sub-accounts for partners. Use it to find account IDs.

  • Calls GET {base_url}/accounts?v=20251101.
  • Results are paged automatically, 1,000 accounts per page.
  • See the Yext API reference for the response fields.

Get Account

Returns the details of the account set in the credential's Account ID: account ID, name, location and sub-account counts, and contact. Use it to check which account the key belongs to.

  • Calls GET {base_url}/accounts/{account_id}?v=20251101.
  • See the Yext API reference for the response fields.

List Users

Lists the users of the account, with each user's ID, name, email, username, roles, and SSO identities. Use it to audit access.

  • Calls GET {base_url}/accounts/{account_id}/users?v=20251101.
  • This template reads only the first page of users that Yext returns.
  • See the Yext API reference for the response fields.

List Roles

Lists the user roles defined in the account, with each role's ID and name. Use it with List Users to see what each user's roles grant.

  • Calls GET {base_url}/accounts/{account_id}/roles?v=20251101.
  • See the Yext API reference for the response fields.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Yext data sources can also be manually configured to ingest data from any valid Yext API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Yext data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Yext destination, and select the Send to Destination option from the menu. Select the Yext connector from the list of available destination connectors, then select the credential that will be used to connect to your Yext account, and click Next; or, create a new Yext credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Yext endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

These templates change data in your Yext account, and the changes can appear on your public listings and reviews. Test them with a single record before sending a full Nexset.

Create Entity

Creates a Knowledge Graph entity of the selected type for each record. New entities can sync to your listings on publishers.

  • Sends POST {base_url}/accounts/{account_id}/entities?v=20251101&entityType={Entity Type}.
  • Entity Type (required; default location): The type of entity to create. Options: location, event, faq, financialProfessional, healthcareFacility, healthcareProfessional, hotel, hotelRoomType, job, organization, product, restaurant, atm.
  • Each record is sent as the JSON request body, one request per record. A record is the entity's fields, for example meta.id, name, address, mainPhone, and hours. The fields each entity type requires are listed in the Yext API reference.
  • See the Yext API reference for the request fields.

Reply to Review

Posts an owner response on a review. The response is public on the publisher unless the record sets visibility to PRIVATE.

  • Sends POST {base_url}/accounts/{account_id}/reviews/{Review ID}/comments?v=20251101.
  • Review ID (required): The numeric ID of the review to reply to. Use List Reviews to find it.
  • Each record is sent as the JSON request body, one request per record. Include content (the response text); visibility (PUBLIC or PRIVATE) and parentId (to reply to a comment) are optional.
  • If your account has Yext's Compliant Review Response setting turned on, Yext needs more information with each response than this template sends, and the response may not be posted.
  • See the Yext API reference for the request fields.

Update Entity

Updates one existing Knowledge Graph entity with the fields in each record. Fields that are not in the record are left unchanged. Changes can sync to your listings on publishers.

  • Sends PUT {base_url}/accounts/{account_id}/entities/{Entity ID}?v=20251101.
  • Entity ID (required): The entity ID (meta.id) of the entity to update.
  • Each record is sent as the JSON request body, one request per record, and every record updates the entity set in Entity ID.
  • See the Yext API reference for the request fields.

Manual configuration​

Yext destinations can also be manually configured to send data to any valid Yext API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Yext endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Yext endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.