Yelp Integration — ModuleX AI

Field	Description	Required	Format
Yelp API Key	Your Yelp Fusion API key from yelp.com/developers	Yes	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

search_businesses — Search businesses matching given criteria such as location, term, categories, price, and attributes

Parameters

string

Geographic area to search. Examples: ‘New York City’, ‘350 5th Ave, New York, NY 10118’. Required if latitude and longitude are not provided.

string

Latitude of the location to search from. Required if location is not provided.

string

Longitude of the location to search from. Required if location is not provided.

string

Search term, e.g. ‘food’ or ‘restaurants’. May also be a business name like ‘Starbucks’.

integer

Maximum number of businesses to return. Yelp enforces a limit of 1000. (Default: 200)

string

Comma-separated category aliases to filter results (e.g. ‘discgolf,restaurants’). See Yelp docs for supported categories.

string

Comma-separated pricing levels: 1 ($), 2 ($$), 3 ($$$), 4 ($$$$). Example: ‘1,2’.

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"
}

get_business_details — Get detailed information about a specific business by its Yelp ID or alias

Parameters

string

required

A unique identifier for a Yelp Business. Can be a 22-character Yelp Business ID or a Yelp Business Alias.

string

Determines the platform for mobile_link. Allowed values: android, ios, mobile-generic.

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"
}

list_business_reviews — List the reviews for a specific business

Parameters

string

required

A unique identifier for a Yelp Business. Can be a 22-character Yelp Business ID or a Yelp Business Alias.

string

Locale code in the format {language}_{country} (e.g. en_US).

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"
}

search_businesses_by_phone_number — Search for businesses by phone number

Parameters

string

required

Phone number to search for. Must start with + and include the country code, e.g. +14159083801.

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"
}

Using

Providers

Building

Tools

Yelp Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Google My Business

Ahrefs

Customer.io

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Google My Business

Ahrefs

Customer.io

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links