The API name is the unique ID for a field in the Yext system backend. API names are used to identify fields for applications such as integrating Yext with other systems.
This article explains how to view a list of fields available for a specific entity type and their corresponding API names.
To view fields and their API names:
- Click Knowledge Graph in the navigation bar and click Configuration.
- Click Entity Types.
- Click View Details next to the desired entity type.
- Click on the Fields tab.
- You’ll see all fields configured for this entity type, organized by field section. The API name for a field is listed directly under the field name.
To add a new field to an entity type, see Create a Custom Field. For more information on creating or editing a section, see Create and Organize Field Sections or Edit the Field Configuration on an Entity Type.