Get Started
To start using our APIs, follow these steps:
  1. Create a developer account
  2. Create an app in the Developer Console
  3. Get your API key
  4. Send your first API request

1. Create a developer account

Go to Developer Account Signup and complete the form to create a developer account. A developer account is a trial account that will immediately give you access to four locations so that you can start working with our APIs. Activity performed in a developer account will never have any effect in production. A Yext subscription is required to use our PowerListings®, Analytics, Reviews, Social, and User endpoints. For more information on how to subscribe, visit our website.
YEXT CLIENTS AND PARTNERS If you are already using our APIs, you do not need to create a developer account and can log in with your current username and password.

2. Create an app in the Developer Console

  1. Log in to your developer account or current Yext account.
  2. Access your Developer Console by pointing to your name in the upper-right corner of the page and selecting Developer Console.
  3. In the Developer Console, click + New App.
  4. Enter the required information and click Create App.

3. Get your API key

After you’ve created your app, look for it in the “Your Apps” section of the Developer Console, and click on its name. The API key for the app should appear under the “Credentials & Linking” section of the app’s page.
APIKey2017
Copy the API key, and keep it somewhere easily accessible so you can complete the next step.

4. Send your first API request

Open your web browser, and go to the following URL:

GET https://api.yext.com/v2/accounts/me/locations?api_key=YOUR_API_KEY&v=YYYYMMDD

where:
  • YOUR_API_KEY is the API key for your app, and
  • YYYYMMDD is today’s date.
The API response should be a list of four Locations, one for each of Yext’s offices:
{
    "meta": {
        "errors": [],
        "uuid": "f1128-b4ef-4803-a47a-3fd70"
    },
    "response": {
        "count": 4,
        "locations": [
            {
                "accountId": "1206158",
                "address": "7900 Westpark Drive",
                "address2": "Suite T200",
                "categoryIds": [
                    "668"
                ],
                "city": "McLean",
                "countryCode": "US",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686765",
                "isPhoneTracked": false,
                "language": "en",
                "localPhone": "6467624579",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "8884442988",
                "state": "VA",
                "suppressAddress": false,
                "timestamp": 1475605507908,
                "websiteUrl": "https://locations.yext.com/us/va/mclean/7900-westpark-drive.html",
                "zip": "22102"
            },
            {
                "accountId": "1206158",
                "address": "48 Warwick St.",
                "address2": "Office 410",
                "categoryIds": [
                    "668"
                ],
                "city": "London",
                "countryCode": "GB",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686766",
                "isPhoneTracked": false,
                "language": "en",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "2037052290",
                "state": "Gt Lon",
                "suppressAddress": false,
                "timestamp": 1475605508191,
                "websiteUrl": "https://locations.yext.com/gb/gt-lon/london/48-warwick-st-.html",
                "zip": "W1B 5AW"
            },
            {
                "accountId": "1206158",
                "address": "500 West Madison St.",
                "address2": "Suite 2810",
                "categoryIds": [
                    "668"
                ],
                "city": "Chicago",
                "countryCode": "US",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686767",
                "isPhoneTracked": false,
                "language": "en",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "2129943900",
                "state": "IL",
                "suppressAddress": false,
                "timestamp": 1475605508686,
                "websiteUrl": "https://locations.yext.com/us/il/chicago/500-west-madison-st-.html",
                "zip": "60661"
            },
            {
                "accountId": "1206158",
                "address": "1 Madison Ave",
                "address2": "5th Floor",
                "categoryIds": [
                    "668"
                ],
                "city": "New York",
                "countryCode": "US",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686768",
                "isPhoneTracked": false,
                "language": "en",
                "localPhone": "2128136543",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "8884442988",
                "state": "NY",
                "suppressAddress": false,
                "timestamp": 1475605509124,
                "websiteUrl": "https://locations.yext.com/us/ny/new-york/1-madison-ave.html",
                "zip": "10010"
            }
        ]
    }
}
You’ve made your first successful API request.

Next steps

To learn more about what you can do with the Knowledge API, check out the following resources: