Home
Learn
Training
Tracks
Tracks
Build your expertise through a collection of training modules
Curriculums
Curriculums
Follow recommended learning paths based on specific products or roles
Resources
Help
Help
Visit our Help Site for articles and answers to product questions
Blog
Blog
Gain insight into product functionality, and best practices
Releases
Releases
Check out the latest seasonal product updates, and monthly Hitchhiker-exclusives
Frontend Code Examples
Admin Code Snippets
Explore code snippets to customize your Answers and Pages build
Inspiration hub
Inspiration Hub
Explore these sample projects highlighting innovative use cases of our software
Guides
Get Started Guides Integration Guides Developer Guides View All
Start Building For Free
Docs
API Docs
Knowledge API Live API Admin API Answers API
SDK & CLI Docs
Answers Headless React Answers Search UI SDK Answers Core SDK Yext CLI CaC Resources
Guides
Get Started Guides Integration Guides Developer Guides View All
Start Building For Free
Community
Resources
Community
Hitchhikers Community
Ask questions, share best practices, and engage with fellow Hitchhikers
Store
Hitchhikers Store
Shop for Hitchhikers apparel, drinkware, and accessories
Events
Events
Explore the calendar of upcoming office hours, workshops, and webinars
Customer Showcase
Customer Showcase
Learn how brands are winning big in search
Ideas
Ideas
Share your ideas and product requests with fellow Hitchhikers and Yext Product Managers
Start Building For Free
Start Building For Free
<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Program Track Completed Knowledge Graph Track Completed Pages Track Completed Answers Track Completed Answers: Advanced Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Knowledge Assistant Track Completed Multi-Language Experiences Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
View Profile
Log Out loading
Ready to be your brand's hero?
Sign up to become a Hitchhiker and build skills that will enhance your career, get access to exclusive Yext resources, and be your brand’s hero by driving consumer engagement.

If you’re already a Hitchhiker, log in to access this content.
Log In Sign Up
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
Search
API Policies & Conventions
Knowledge APIs
Expand Expand
Knowledge Graph
Expand Expand
Entities
Expand Expand
Entities
Expand Expand
Entities: List
Entities: Create
Entities: Get
Entities: Update
Entities: Delete
Entity Language Profiles
Expand Expand
Entity Language Profiles: List
Entity Language Profiles: List All
Entity Language Profiles: Get
Entity Language Profiles: Upsert
Entity Language Profiles: Delete
Locations (Legacy)
Expand Expand
Locations (Legacy): List
Locations (Legacy): Create
Locations (Legacy): Search
Locations (Legacy): Get
Locations (Legacy): Update
Language Profiles (Legacy)
Expand Expand
Language Profiles (Legacy): List
Language Profiles (Legacy): Get
Language Profiles (Legacy): Upsert
Language Profiles (Legacy): Delete
Folders
Expand Expand
Folders: List
ECLs
Expand Expand
Menus
Expand Expand
Menus: List
Menus: Create
Menus: Get
Menus: Update
Menus: Delete
Bios
Expand Expand
Bios: List
Bios: Create
Bios: Get
Bios: Update
Bios: Delete
Products
Expand Expand
Products: List
Products: Create
Products: Get
Products: Update
Products: Delete
Events (Legacy)
Expand Expand
Events (Legacy): List
Events (Legacy): Create
Events (Legacy): Get
Events (Legacy): Update
Events (Legacy): Delete
Categories & Google Attributes
Expand Expand
Categories
Google Fields
Custom Fields
Expand Expand
Custom Fields: List
Custom Fields: Create
Custom Fields: Get
Custom Fields: Update
Custom Fields: Delete
Assets
Expand Expand
Assets: List
Assets: Create
Assets: Get
Assets: Update
Assets: Delete
Connectors
Expand Expand
Connectors: Push Data
Connectors: Trigger
Suggestions
Listings
Expand Expand
Listings Management
Expand Expand
Listings
Expand Expand
Listings: List
Listings: Opt In
Listings: Opt Out
Entity Listings
Expand Expand
Entity Listings: List
Entity Listings: Delete
Duplicates
Expand Expand
Duplicates: List
Duplicates: Create
Duplicates: Delete
Duplicates: Suppress
Publishers
Publisher Suggestions
Expand Expand
Publisher Suggestions: List
Publisher Suggestions: Get
Publisher Suggestions: Update
Google Verification
Expand Expand
Verification Methods
Verification Statuses
Verification
Expand Expand
Verification: Initiate
Verification: Complete
Listing Admins
Expand Expand
Listing Admins: List
Listing Admin: Invite
Q&A
Expand Expand
Questions
Expand Expand
Questions: List
Question: Get
Answer
Expand Expand
Answer: Create
Answer: Update
Answer: Delete
Analytics
Expand Expand
Activity Log
Catalog
Max Dates
Reports
Report Status
Reviews
Expand Expand
Review Management
Expand Expand
Reviews
Expand Expand
Reviews: List
Reviews: Create
Review: Get
Review: Update
Comment
Expand Expand
Comment: Create
Comment: Update
Comment: Delete
Review Labels
Review Generation
Expand Expand
Review Invitations
Expand Expand
Review Invitations: List
Review Invitations: Create
Review Invitation: Get
Review Invitation: Update
Review Invitation: Delete
Review Generation Settings
Expand Expand
Review Generation Settings: Get
Review Generation Settings: Update
Logs
Expand Expand
Tables
Table Schema
Query
Social
Expand Expand
Post
Expand Expand
Post
Expand Expand
Posts: List
Post: Create
Post: Get
Post: Update
Post: Delete
Entity Post
Expand Expand
Entity Post: Delete
Entity Post: Create Comment
Account Settings
Expand Expand
Users
Expand Expand
Roles
Users
Expand Expand
Users: List
Users: Create
Users: Get
Users: Update
Users: Delete
Users: Update Password
Approval Groups
Expand Expand
ApprovalGroups: List
Approval Groups: Create
ApprovalGroups: Get
ApprovalGroups: Update
ApprovalGroups: Delete
Accounts
Expand Expand
Accounts: List
Accounts: Get
Linked Accounts
Expand Expand
LinkedAccounts: List
LinkedAccounts: Get
LinkedAccounts: Assign
Optimization Tasks
Expand Expand
Optimization Tasks: List
Optimization Tasks: Get Link
Webhooks
Expand Expand
Knowledge Graph
Expand Expand
Entities
Locations
ECLs
Expand Expand
Menus: Webhook
Bios: Webhook
Products: Webhook
Events: Webhook
Listings
Expand Expand
Listings
Entity Listings
Duplicates
Publisher Suggestions
Q&A
Reviews
Expand Expand
Reviews
Review Invitations
Streams
Expand Expand
Streams: Webhook
Unlink Account
Expand Expand
Account Unlink: Webhook
Add Request
Expand Expand
Add Request Update: Webhook
Live APIs (Consumer Grade)
Expand Expand
Knowledge Graph Live API
Expand Expand
Entities
Expand Expand
Entities
Expand Expand
Entities: List
Entities: Get
Entities: GeoSearch
Entities Schema: Get
Entity Language Profiles
Expand Expand
Entity Language Profiles: Get
Entity Language Profiles: List
Entity Language Profiles: List All
Locations (Legacy)
Expand Expand
Language Profiles (Legacy): Get
Language Profiles Schema (Legacy): Get
Locations (Legacy): Get
Locations (Legacy): List
Locations Schema (Legacy): Get
Locations (Legacy): GeoSearch
ECLs
Expand Expand
Menus
Bios
Products
Events (Legacy)
Q&A Submission
Expand Expand
Q&A Submission
Review Submission
Expand Expand
Review Submission
Expand Expand
Review: Create
Review: Update
Review: Delete
Streams
Expand Expand
Streams
Expand Expand
Streams: Get
Streams: List
Answers API
Expand Expand
Universal Search
Expand Expand
Universal Search: Autocomplete
Universal Search: Query
Vertical Search
Expand Expand
Vertical Search: Autocomplete
Vertical Search: Query
Vertical Search: Filter Search
Secure Token
Expand Expand
Secure Token
Admin APIs (Partner)
Expand Expand
Available Services
Expand Expand
Available Services: List
Add Requests
Expand Expand
Add Requests: Create (New Location)
Add Requests: Create (Existing Location)
Add Requests: Create (Existing Sub-Account)
Add Requests: Process (Sandbox API Only)
Add Requests: List (Location)
Add Requests: Get (Location)
Add Requests: List (Sub-Account)
Add Requests: Get (Sub-Account)
Services
Expand Expand
Services: Cancel (Location)
Services: Cancel (Sub-Account)
Services: Cancel All (Sub-Account)
Services: List (Location)
Services: List (Sub-Account)
Accounts
Expand Expand
Accounts: Create Sub-Account
Accounts: List
Accounts: Get
Accounts: Update
Resources Apply Requests
Expand Expand
Resources Apply Request: Create (Account)
Resources Apply Request Status: Get (Account)
Answers Headless React
Answers Headless
Answers Core SDK
Answers Search UI SDK
Expand Expand
Core Concepts
Expand Expand
Answers Initialization
Components
Universal vs. Vertical Search
Result Cards
Expand Expand
Built-In Card Configuration
Card Data Mapping
Card Calls To Action
Data Formatting
Built In Cards
Pages
Expand Expand
Universal Search Results Page
Vertical Search Results Page
No Results
Components
Expand Expand
SearchBar
Navigation
SpellCheck
DirectAnswer
UniversalResults
VerticalResults
FilterSearch
FilterOptions
FilterBox
Facets
SortOptions
QASubmission
Map
Pagination
LocationBias
Icon
Initialization Options
Expand Expand
verticalPages
search
onUniversalSearch
onVerticalSearch
Advanced Concepts
Expand Expand
Component Lifecycle and State
Using a Custom Renderer
Custom Data Transforms
Using a Custom Template for a Component
Custom Data Formatting
Creating Custom Components
More Information
Expand Expand
Versions
Bundles
Yext CLI (Beta)
Expand Expand
Installation
Getting Started
Expand Expand
Link Your Account
Exploring Commands & Using the Help Flag
Universal Commands
Expand Expand
init
info
completion
Resources Command Group
Expand Expand
apply
diff
pull
copy
Service Users Command Group
Expand Expand
activate
create
list
remove
Streams CLI Command Group
Expand Expand
list
refresh list
refresh status
view records
Configuration Resources
Expand Expand
Analytics
Expand Expand
Conversion Action
Dashboard
Insight
Answers
Expand Expand
Answers Configuration
Experience Training
Saved Query
Crawler
Expand Expand
Yext Crawler
Knowledge Manager
Expand Expand
Connector
Entity
Entity Folder
Entity Label
Entity Preview
Entity Template
Entity Type
Entity Type Extension
Entity Upload Configuration
Field
Field Eligibility Group
Field Presentation
Field Type
Knowledge Graph Settings
Saved Filter
Listings
Expand Expand
Publisher
Pages
Expand Expand
Authentication Policy
Domain
Module
Page Builder Template
Site
Platform
Expand Expand
Account Features
Home Screen
Plugin
Role
Streams
Expand Expand
Streams Endpoint
home
loading

Live APIs (Consumer Grade) | Hitchhikers Platform

Overview

Use the Live API to surface entity information for any consumer-facing applications such as locators, mobile apps, email applications, in-store receipts, and more.

Use Cases
  • Show a list of nearby locations
  • Inject schema.org markup onto your webpages
  • Build a store locator or help site search
Reference Docs