Yelp
API actions for the Yelp integration.
Yelp
Discover businesses, reviews, and events on Yelp.
Get business details
Look up detailed information about a specific Yelp business.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
business_id | string | Yes | The ID of the Yelp business to look up. |
Response
{
"categories": [
"French",
"Fine Dining"
],
"id": "the-french-laundry-yountville",
"name": "The French Laundry",
"phone": "+17079442380",
"price": "$$$$",
"rating": 4.5,
"review_count": 3200,
"url": "https://www.yelp.com/biz/the-french-laundry-yountville"
}Get business reviews
List reviews for a Yelp business.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
business_id | string | Yes | The ID of the Yelp business to get reviews for. |
limit | number | No | Maximum number of reviews to return. Defaults to 3. |
Response
{
"count": 1,
"reviews": [
{
"id": "xAG4O7l-t1ubbwVAlPnDKg",
"rating": 5,
"text": "Amazing meal from start to finish.",
"time_created": "2024-05-01 12:00:00",
"url": "https://www.yelp.com/biz/the-french-laundry-yountville",
"user": "Alex M."
}
]
}Search businesses
Search for businesses on Yelp by keyword and location.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
term | string | Yes | What to search for, such as a cuisine, business name, or keyword. |
location | string | Yes | City, neighborhood, or address to search in. |
limit | number | No | Maximum number of results to return. Defaults to 5. |
categories | string | No | Filter results by a Yelp category, for example restaurants. |
price | string | No | Only show businesses at this price level. |
sort_by | string | No | How to order the businesses. Defaults to best match. |
open_now | boolean | No | Set to true to only include businesses that are open right now. |
Response
{
"businesses": [
{
"id": "the-french-laundry-yountville",
"location": "6640 Washington St",
"name": "The French Laundry",
"phone": "+17079442380",
"rating": 4.5,
"review_count": 3200,
"url": "https://www.yelp.com/biz/the-french-laundry-yountville"
}
],
"count": 1
}Search events
Find events on Yelp by location.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
location | string | Yes | City, neighborhood, or address to find events in. |
limit | number | No | Maximum number of events to return. Defaults to 5. |
sort_on | string | No | How to order the events. Defaults to most popular. |
Response
{
"count": 1,
"events": [
{
"category": "food-and-drink",
"description": "Weekly farmers market by the waterfront.",
"id": "oakland-jack-london-square-farmers-market",
"is_free": true,
"name": "Jack London Square Farmers Market",
"time_start": "2024-06-02 10:00:00",
"url": "https://www.yelp.com/events/oakland-jack-london-square-farmers-market"
}
]
}