Yelp
A connector to the Yelp Fusion API for searching businesses, reviews, events, and categories.
What you can ask
- Find sushi restaurants with 4+ stars within 2 miles, open now.
- Pull the top 10 coffee shops in the Mission, sorted by review count.
- Show me the average rating and review count for our top 3 competitors.
Set up
Yelp connects with credentials from your Yelp account. Have these values ready:
- API key
- Go to Organization > Connectors and find Yelp.
- Click Enable and choose which tools to allow.
- Each member enters their own values the first time they use it.
To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.
Tools
Yelp offers 19 tools. Admins choose which ones agents can use. See Tool permission groups.
Read (19)
View and search information without changing it.
| Tool | What it does |
|---|---|
autocomplete | Get autocomplete suggestions for search text. |
get_business | Get detailed info for a business by ID or alias, including hours, photos, price, rating, and location. |
get_business_insights | Get business insights including review trends and competitive benchmarks. |
get_category | Get details for a specific category by alias (e.g. 'pizza'). |
get_engagement_metrics | Get engagement metrics (page views, ad clicks, calls, etc.) for one or more businesses. |
get_event | Get details for a specific event by ID. |
get_featured_event | Get the featured event for a location. |
get_food_and_drinks_insights | Get food and drink insights for a business, including trending items. |
get_review_highlights | Get review highlight excerpts for a business, showing key themes from reviews. |
get_reviews | Get reviews for a business. |
get_risk_signal_insights | Get risk signal insights for a business (e.g. health inspection issues). |
get_service_offerings | Get service offerings for a business (e.g. plumbing, electrical). |
list_categories | List all Yelp business categories. |
match_business | Match a business by name, address, city, state, and country. |
search_businesses | Search businesses by term, location, category, price, and more. |
search_businesses_by_phone | Find businesses by phone number. |
search_events | Search for events by location, category, date range, and more. |
search_food_delivery | Search businesses that offer food delivery. |
validate_credential | Validate Yelp API credentials by making a test API call. |