Skip to main content

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
  1. Go to Organization > Connectors and find Yelp.
  2. Click Enable and choose which tools to allow.
  3. 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.

ToolWhat it does
autocompleteGet autocomplete suggestions for search text.
get_businessGet detailed info for a business by ID or alias, including hours, photos, price, rating, and location.
get_business_insightsGet business insights including review trends and competitive benchmarks.
get_categoryGet details for a specific category by alias (e.g. 'pizza').
get_engagement_metricsGet engagement metrics (page views, ad clicks, calls, etc.) for one or more businesses.
get_eventGet details for a specific event by ID.
get_featured_eventGet the featured event for a location.
get_food_and_drinks_insightsGet food and drink insights for a business, including trending items.
get_review_highlightsGet review highlight excerpts for a business, showing key themes from reviews.
get_reviewsGet reviews for a business.
get_risk_signal_insightsGet risk signal insights for a business (e.g. health inspection issues).
get_service_offeringsGet service offerings for a business (e.g. plumbing, electrical).
list_categoriesList all Yelp business categories.
match_businessMatch a business by name, address, city, state, and country.
search_businessesSearch businesses by term, location, category, price, and more.
search_businesses_by_phoneFind businesses by phone number.
search_eventsSearch for events by location, category, date range, and more.
search_food_deliverySearch businesses that offer food delivery.
validate_credentialValidate Yelp API credentials by making a test API call.
⌘J