Skip to main content
Yelp logo

​
Overview

Add Yelp to any ModuleX agent or workflow. Search for businesses, read reviews, and get business details via the Yelp Fusion API (api.yelp.com/v3).
Categories: Marketing & Advertising · Local Services · Reviews · Business Data · Auth: API Key · Actions: 4

​
Authentication

​
API Key Authentication

Authenticate using your Yelp Fusion API key
1

Step 1

Go to https://www.yelp.com/developers and sign in
2

Step 2

Navigate to ‘Manage App’ or create a new app
3

Step 3

Copy your API Key from the app settings
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Yelp API KeyYour Yelp Fusion API key from yelp.com/developersYesxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
location
string
Geographic area to search. Examples: ‘New York City’, ‘350 5th Ave, New York, NY 10118’. Required if latitude and longitude are not provided.
​
latitude
string
Latitude of the location to search from. Required if location is not provided.
​
longitude
string
Longitude of the location to search from. Required if location is not provided.
​
term
string
Search term, e.g. ‘food’ or ‘restaurants’. May also be a business name like ‘Starbucks’.
​
max_results
integer
Maximum number of businesses to return. Yelp enforces a limit of 1000. (Default: 200)
​
categories
string
Comma-separated category aliases to filter results (e.g. ‘discgolf,restaurants’). See Yelp docs for supported categories.
​
price
string
Comma-separated pricing levels: 1 ($), 2 ($$), 3 ($$$), 4 ($$$$). Example: ‘1,2’.
​
attributes
string
Comma-separated additional filters: hot_and_new, request_a_quote, reservation, waitlist_reservation, deals, gender_neutral_restrooms, open_to_all, wheelchair_accessible.

​
Response

{
  "$defs": {
    "BusinessSummary": {
      "additionalProperties": false,
      "description": "A business object returned by Yelp search endpoints.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "alias": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Alias"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "image_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Image Url"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "review_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Review Count"
        },
        "categories": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Categories",
          "type": "array"
        },
        "rating": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Rating"
        },
        "coordinates": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Coordinates"
        },
        "location": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Location"
        },
        "phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Phone"
        },
        "display_phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Phone"
        },
        "distance": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Distance"
        }
      },
      "title": "BusinessSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "businesses": {
      "items": {
        "$ref": "#/$defs/BusinessSummary"
      },
      "title": "Businesses",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchBusinessesOutput",
  "type": "object"
}

​
Parameters

​
business_id_or_alias
string
required
A unique identifier for a Yelp Business. Can be a 22-character Yelp Business ID or a Yelp Business Alias.
​
device_platform
string
Determines the platform for mobile_link. Allowed values: android, ios, mobile-generic.
​
locale
string
Locale code in the format {language}_{country} (e.g. en_US).

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "business": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Business"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetBusinessDetailsOutput",
  "type": "object"
}

​
Parameters

​
business_id_or_alias
string
required
A unique identifier for a Yelp Business. Can be a 22-character Yelp Business ID or a Yelp Business Alias.
​
locale
string
Locale code in the format {language}_{country} (e.g. en_US).
​
sort_by
string
Sort order for reviews. Allowed values: yelp_sort, newest.

​
Response

{
  "$defs": {
    "ReviewSummary": {
      "additionalProperties": false,
      "description": "A review object returned by the reviews endpoint.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "text": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Text"
        },
        "rating": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Rating"
        },
        "time_created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Time Created"
        },
        "user": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User"
        }
      },
      "title": "ReviewSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "reviews": {
      "items": {
        "$ref": "#/$defs/ReviewSummary"
      },
      "title": "Reviews",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    },
    "possible_languages": {
      "items": {
        "type": "string"
      },
      "title": "Possible Languages",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListBusinessReviewsOutput",
  "type": "object"
}

​
Parameters

​
phone
string
required
Phone number to search for. Must start with + and include the country code, e.g. +14159083801.
​
locale
string
Locale code in the format {language}_{country} (e.g. en_US).

​
Response

{
  "$defs": {
    "BusinessSummary": {
      "additionalProperties": false,
      "description": "A business object returned by Yelp search endpoints.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "alias": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Alias"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "image_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Image Url"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "review_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Review Count"
        },
        "categories": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Categories",
          "type": "array"
        },
        "rating": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Rating"
        },
        "coordinates": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Coordinates"
        },
        "location": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Location"
        },
        "phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Phone"
        },
        "display_phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Phone"
        },
        "distance": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Distance"
        }
      },
      "title": "BusinessSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "businesses": {
      "items": {
        "$ref": "#/$defs/BusinessSummary"
      },
      "title": "Businesses",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchBusinessesByPhoneNumberOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limit: 5,000 API calls per day (per Yelp Fusion free tier).
  • Search pagination: Maximum offset of 1,000 results; each page returns up to 50 businesses.
  • Reviews: Returns up to 3 reviews per business (Yelp API limitation).
  • Error model: Non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Google My Business

Ahrefs

Customer.io