--- agentTools: projectIndex: https://docs.developer.yelp.com/llms.txt --- # Phone Search This endpoint returns a list of businesses based on the provided phone number. It is possible for more than one business to have the same phone number (for example, chain stores with the same +1 800 phone number). Note: at this time, the API does not return businesses without any reviews. > 📘 > > This endpoint is part of Yelp Places API, visit [Yelp Places API](https://docs.developer.yelp.com/docs/fusion-intro) to learn more. # OpenAPI definition ````json { "openapi": "3.1.0", "info": { "title": "Businesses", "version": "1.0" }, "servers": [ { "url": "https://api.yelp.com" } ], "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://biz.yelp.com/oauth2/authorize", "tokenUrl": "https://api.yelp.com/oauth2/token/v3", "scopes": { "leads": "Access Yelp Leads on your behalf, including reading and responding to messages, and storing message data" } } } }, "bearerAuth": { "type": "http", "scheme": "bearer", "description": "To authenticate API calls with the API Key, set the Authorization HTTP header value as `Bearer API_KEY`.\n\nExample: `Bearer 23813239889e947efd3e787cc41b0b839f442a85c5bfd30bd4b9a85ec3a54d5cae4d52b37ff52e64deb9c83bd04883812a6cebde04f2f25752f31be0ac74b514`.\n\nYou can create or find your API Key at [yelp.com](https://www.yelp.com/developers/v3/manage_app).\n" } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/ai/chat/v2": { "post": { "summary": "Yelp AI API (Search & Chat)", "tags": [ "Businesses" ], "description": "The Yelp AI API endpoint brings conversational intelligence to your applications, enabling users to ask natural language questions and receive real-time, contextually relevant answers powered by Yelp’s latest business data and reviews.\n\n**Yelp AI API Features**\n- **Next generation search & discovery** - Search with natural language, discover, and connect with contextually relevant businesses.\n- **Multi-turn conversations** - Support back-and-forth interactions and refine queries with follow-up questions.\n- **Direct business queries** - Ask targeted questions about businesses without needing to perform a prior search.\n- **Conversational restaurant reservations** - Explore availability and book a table at restaurants through natural language interactions. (Please note that this feature is available on request only. To enable reservations, please contact us.)\n- **Instant quotes for home services** - Simply describe the service you need (like “I need quotes for fixing a leaking faucet”), and Yelp AI API instantly connects you with top local pros, so you receive multiple quotes from the best professionals for your job. (Currently in beta and not yet publicly available.)\n\n🚀 **Try it now** - Test Yelp AI API for free in our **playground** and see real-time responses in action.\n\n🛠️ For a detailed, step-by-step guide on integrating this endpoint into your application, check out the **Getting Started with Yelp AI API guide**.\n", "operationId": "v2_ai_chat", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "This object captures the user’s request to the Fusion AI Chat endpoint. It includes\nthe conversational query, optional user context for more relevant results, and\nan optional chat_id for session continuity.\n", "properties": { "query": { "type": "string", "description": "• Natural language text for querying Yelp-specific information.\n• Accepts any prompt related to Yelp businesses, such as “Can you find a Thai restaurant near me?”\n• This should be plain text (no special formatting needed).\n", "maxLength": 1000 }, "chat_id": { "type": "string", "description": "• Uniquely identifies the current conversation (chat session).\n• For the first request, set this to null or omit it; the API will respond with a new chat_id.\n• Use the returned chat_id on subsequent requests to continue the same conversation.\n• If omitted on subsequent requests, a new conversation is started.\n• If an invalid chat_id is provided, the request will fail.\n", "x-nullable": true }, "user_context": { "type": "object", "description": "Contains optional location data (latitude and longitude) that can help the AI\ntailor results to a user’s location. If not provided and a location-based query\nis asked, the system may prompt the user to specify a location.\n", "properties": { "latitude": { "type": "number", "description": "• User’s approximate latitude.\n• If provided, it helps return more location-specific results.\n• Otherwise, the system may ask for location details if needed (e.g., for searches).\n", "format": "float", "x-nullable": true }, "longitude": { "type": "number", "description": "• User's approximate longitude.\n• If provided, it helps return more location-specific results.\n• Otherwise, the system may ask for location details if needed.\n", "format": "float", "x-nullable": true } } }, "request_context": { "type": "object", "description": "Contains optional settings that control how the API processes the request.\nThese settings affect the response format and content generation behavior.\n", "properties": { "skip_text_generation": { "type": "boolean", "description": "• When set to true, skips LLM text generation and returns only structured data.\n• The response will contain empty text and tags, but all structured data\n (businesses, entities, types) will still be returned.\n• Useful for clients that only need structured data and want to reduce latency.\n", "default": false } } } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "A successful response", "content": { "application/json": { "schema": { "type": "object", "description": "Represents the AI Chat response returned by Yelp’s Fusion AI endpoint. It includes\na conversational response, any structured data (entities) relevant to the query,\nand a chat_id for tracking the user session.\n", "properties": { "chat_id": { "type": "string", "description": "A unique Yelp-generated Chat ID that ties all requests to a specific conversation.\n• This remains the same if the user provided a valid chat_id in the request.\n• It is static throughout one session.\n" }, "response": { "type": "object", "description": "Contains a contextually relevant response message for the user’s query:\n• Might be one or multiple sentences.\n• May include follow-up questions if needed (e.g. to request user’s location).\n", "properties": { "text": { "description": "The AI-generated textual response to the user’s query. For example, it may\ncontain an answer, an additional prompt, or instructions to refine the query.\n", "type": "string" }, "tags": { "description": "Additional metadata tags that provide context about the response.\nThese tags can be used to enrich the response or display additional information.\n", "type": "array", "items": { "type": "object", "description": "Additional metadata tags that provide context about the response.\nThese tags can be used to enrich the response or display additional information.\n", "properties": { "start": { "type": "number", "description": "The start index of a particular style/information. e.g. highlight/business name/etc" }, "end": { "type": "number", "description": "The end index of a particular style/information. e.g. highlight/business name/etc" }, "tag_type": { "type": "string", "description": "The type of metadata tag. Valid values:\n• highlight - indicates a highlighted text in the response.\n• business - indicates the name of a business mentioned in the response.\n" }, "meta": { "type": "object", "description": "Additional metadata that can provide more context about the tag.\nThis can include information like business ID, category, or other relevant details.\n", "x-nullable": true } } }, "x-nullable": true } } }, "types": { "type": "array", "description": "A list of response categories indicating the nature of the answer. Valid values:\n• business_search\n• business_question\n• clarification\n• unsupported\n• confirmation\n", "items": { "type": "string" } }, "entities": { "type": "array", "description": "Structured data corresponding to the businesses or other entities referenced\nin the AI response. If the response does not reference specific businesses, this\narray may be empty.\n", "items": { "type": "object", "description": "An entity in the AI Chat response, typically containing a collection of businesses\nrelevant to the user’s query.\n", "properties": { "businesses": { "type": "array", "description": "A list of Yelp business objects that the AI response refers to. The data may be\npartially or fully populated depending on the nature of the query.\n", "items": { "type": "object", "description": "Standard Yelp business object enhanced for AI Chat responses.\n", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Name of this business." }, "alias": { "type": "string", "description": "Unique Yelp alias of this business. Can contain unicode characters.\nExample: 'yelp-san-francisco'. Also see What's the difference between the Yelp business ID and business alias?\n" }, "url": { "type": "string", "description": "URL for business page on Yelp." }, "location": { "type": "object", "properties": { "address1": { "x-nullable": true, "description": "Street address of this business." }, "address2": { "x-nullable": true, "description": "Street address of this business, continued." }, "address3": { "x-nullable": true, "description": "Street address of this business, continued." }, "city": { "x-nullable": true, "description": "City of this business." }, "state": { "x-nullable": true, "description": "[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) (with a few [exceptions](https://docs.developer.yelp.com/docs/resources-state-codes)) state code of this business." }, "zip_code": { "x-nullable": true, "description": "[Zip code](https://en.wikipedia.org/wiki/Postal_code) of this business." }, "country": { "x-nullable": true, "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of this business." } } }, "coordinates": { "x-nullable": true, "type": "object", "description": "Coordinates of this business.", "properties": { "latitude": { "type": "number", "description": "Latitude position on map." }, "longitude": { "type": "number", "description": "Longitude position on map." } } }, "review_count": { "type": "integer", "description": "Number of reviews for this business." }, "price": { "type": "string", "description": "Price level of the business. Value is one of *$*, *$$*, *$$$* or *$$$$*.", "x-nullable": true }, "rating": { "type": "number", "format": "double", "description": "Rating for this business (value ranges from 1, 1.5, ... 4.5, 5).", "x-nullable": true }, "categories": { "type": "array", "description": "A list of Yelp Categories", "items": { "type": "object", "properties": { "alias": { "type": "string", "description": "Alias of a category, when searching for business in certain categories, use alias rather than the title." }, "title": { "type": "string", "description": "Title of a category for display purpose." } } } }, "attributes": { "type": "object", "description": "Various features or facilities provided by the business." }, "phone": { "type": "string", "description": "Phone number of the business.", "x-nullable": true }, "summaries": { "type": "object", "description": "AI-generated textual summaries for this business. These are not specific to the user’s query.\n", "properties": { "short": { "type": "string", "description": "A short, typically single-sentence summary.", "x-nullable": true }, "medium": { "type": "string", "description": "A medium-length summary (2–3 sentences).", "x-nullable": true }, "long": { "type": "string", "description": "A more detailed paragraph-length summary.", "x-nullable": true } } }, "contextual_info": { "type": "object", "description": "Additional context relevant to the user’s specific query, if applicable.", "properties": { "summary": { "type": "string", "description": "A contextual summary relevant to the user’s query. May be null if not applicable.\n", "x-nullable": true }, "review_snippets": { "type": "array", "description": "Automatically selected short excerpts from user reviews, based on the query.", "items": { "type": "object", "properties": { "review_id": { "type": "string" }, "comment": { "type": "string" }, "rating": { "type": "number", "format": "double" }, "timestamp": { "x-nullable": true, "type": "integer" } }, "required": [ "review_id", "comment", "rating" ] } }, "business_hours": { "x-nullable": true, "type": "array", "items": { "type": "object", "properties": { "day_of_week": { "type": "string" }, "business_hours": { "type": "array", "items": { "type": "object", "properties": { "open_time": { "type": "string" }, "close_time": { "type": "string" } }, "required": [ "open_time", "close_time" ] } } }, "required": [ "day_of_week", "business_hours" ] } }, "photos": { "x-nullable": true, "description": "A list of Yelp-hosted photo objects.\n", "type": "array", "items": { "type": "object", "properties": { "original_url": { "type": "string" } }, "required": [ "original_url" ] } }, "review_snippet": { "type": "string", "description": "A single representative snippet from a review.\n", "x-nullable": true }, "accepts_reservations_through_yelp": { "type": "boolean", "description": "Whether the business accepts reservations through Yelp", "x-nullable": true }, "reservation_availability": { "type": "object", "x-nullable": true, "description": "Contains reservation availability information for the business.\nThis field is only present if the business accepts reservations through Yelp.\n", "properties": { "openings": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format" }, "slots": { "type": "array", "items": { "type": "object", "properties": { "time": { "type": "string", "description": "Time in HH:MM format" }, "seating_areas": { "type": "array", "items": { "type": "string" }, "description": "List of available seating areas" } }, "required": [ "time", "seating_areas" ] }, "description": "Available reservation slots for this date" } }, "required": [ "date", "slots" ] }, "description": "List of available reservation slots." } }, "required": [ "openings" ] } } } }, "required": [ "id", "name", "location", "coordinates", "categories", "attributes", "summaries" ] } } } } }, "request_a_quote_survey": { "x-nullable": true, "description": "Request a Quote survey information when the user is in a quote request flow.\nThis field will be populated when the AI determines the user wants to request\nquotes from businesses for services.\n", "type": "object", "properties": { "job_display_name": { "type": "string", "description": "Display name for the job type" }, "status": { "type": "string", "enum": [ "in_progress", "awaiting_user_info", "awaiting_confirmation", "awaiting_submit_to_nearby", "submitted", "failed" ], "description": "Status of the Request a Quote survey" }, "questions": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The question text" }, "available_choices": { "type": "array", "items": { "type": "string" }, "x-nullable": true, "description": "List of available choices for the question" }, "only_accepts_choices": { "type": "boolean", "default": false, "description": "Whether the question only accepts predefined choices" }, "is_multi_select": { "type": "boolean", "default": false, "description": "Whether multiple choices can be selected" }, "required": { "type": "boolean", "default": false, "description": "Whether the question is required" }, "user_response": { "type": "array", "items": { "type": "string" }, "x-nullable": true, "description": "User's response to the question" } }, "required": [ "text" ] }, "description": "List of survey questions" }, "user_info": { "x-nullable": true, "type": "object", "properties": { "first_name": { "type": "string", "x-nullable": true }, "last_name": { "type": "string", "x-nullable": true }, "email": { "type": "string", "x-nullable": true }, "phone": { "type": "string", "x-nullable": true }, "zip_code": { "type": "string", "x-nullable": true } } }, "requested_biz_ids": { "type": "array", "items": { "type": "string" }, "x-nullable": true, "description": "List of encrypted business IDs requested for quotes" }, "num_matched_businesses": { "type": "integer", "x-nullable": true, "description": "Number of businesses matched for this request" }, "submit_to_nearby_businesses": { "type": "boolean", "default": false, "description": "Whether to submit quote request to nearby businesses" } }, "required": [ "job_display_name", "status", "questions" ] } }, "required": [ "chat_id" ] }, "examples": { "Find Pizza places in Chicago": { "value": { "response": { "text": "Here are some places in Chicago offering delicious pizza with a variety of toppings and a satisfying dining experience.", "tags": [ { "tag_type": "highlight", "start": 41, "end": 56 } ] }, "types": [ "business_search" ], "entities": [ { "businesses": [ { "id": "8vsdJH_paXsgre3_KAa3w", "alias": "lou-malnatis-pizzeria-chicago", "name": "Lou Malnati's Pizzeria", "url": "https://www.yelp.com/biz/lou-malnatis-pizzeria-chicago?adjust_creative=3aOVd6DAVkgZJsTctgMtSA&utm_campaign=yelp_api_v3&utm_medium=api_v3_public_ai_api_chat_v2&utm_source=3aOVd6DAVkgZJsTctgMtSA", "location": null, "address1": "439 North Wells St", "address2": null, "address3": null, "city": "Chicago", "zip_code": null, "state": "IL", "country": "US", "formatted_address": "439 North Wells St\\nChicago, IL 60610", "coordinates": null, "latitude": 41.890357, "longitude": -87.633704, "review_count": 7595, "price": "$", "rating": 4.1, "categories": [ { "alias": "pizza", "title": "Pizza" }, { "alias": "italian", "title": "Italian" }, { "alias": "sandwiches", "title": "Sandwiches" } ], "attributes": { "BusinessAcceptsAndroidPay": false, "BusinessAcceptsApplePay": false, "PokestopNearby": true, "BusinessUrl": "https://www.loumalnatis.com/chicago-river-north", "AboutThisBizBioPhotoDict": null, "AboutThisBizBusinessRecommendation": [], "BusinessAddressAlternate": null, "BusinessCategorySic": null, "BusinessMovedFrom": null, "BusinessNameAlternate": null, "BusinessOpeningDate": null, "BusinessTempClosed": null, "GroupName": null, "StoreCode": null, "AboutThisBizBio": null, "AboutThisBizBioFirstName": null, "AboutThisBizBioLastName": null, "AboutThisBizHistory": null, "AboutThisBizRole": null, "AboutThisBizSpecialties": "If you're on the hunt for the best pizza River North has to offer, look no further than Lou Malnati's. Located in the Near North Side of Chicago neighborhood, you can enjoy Legendary Chicago Deep Dish and thin crust at the place that's been perfecting it for 50+ years. Our River North restaurant features a full-service bar, dine-in, carryout, delivery, group ordering, and drop-off catering. During the warmer months, we also offer outdoor seating. While you're out in this vibrant, ultra-stylish neighborhood, Lou Malnati's River North is the perfect spot to satiate your deep dish cravings.", "AboutThisBizYearEstablished": null, "Alcohol": "full_bar", "Ambience": { "divey": false, "hipster": false, "casual": true, "touristy": null }, "BikeParking": true, "BusinessAcceptsBitcoin": null, "BusinessAcceptsCreditCards": true, "BusinessDisplayUrl": "http://www.loumalnatis.com", "GoodForKids": true, "GoodForMeal": { "dessert": false, "latenight": null, "lunch": true, "dinner": true, "brunch": false, "breakfast": false }, "HappyHour": null, "HasTV": true, "MenuUrl": "http://www.loumalnatis.com/our-menu", "NationalProviderIdentifier": null, "NoiseLevel": "average", "OffersMilitaryDiscount": null, "RestaurantsTakeOut": true, "WaitlistReservation": null, "WheelchairAccessible": null, "WiFi": "free" }, "phone": 13128289800, "summaries": { "short": null, "medium": null, "long": null }, "contextual_info": { "summary": "Known for its classic Chicago-style deep dish pizza, this family-friendly pizzeria offers a rich and luxurious dining experience. With a thick crust and generous cheese, it's a must-visit for pizza lovers in the area. While the wait for a table can be long, pre-ordering is available to satisfy your craving for their delicious pies. Don't forget to try the Chocolate Chip Pizza for a sweet finish!", "review_snippets": [], "business_hours": [ { "day_of_week": "Monday", "business_hours": [ { "open_time": "2025-02-03 11:00:00", "close_time": "2025-02-03 23:00:00", "special_hours_applied": false } ] }, { "day_of_week": "Tuesday", "business_hours": [ { "open_time": "2025-02-04 11:00:00", "close_time": "2025-02-04 23:00:00", "special_hours_applied": false } ] }, { "day_of_week": "Wednesday", "business_hours": [ { "open_time": "2025-02-05 11:00:00", "close_time": "2025-02-05 23:00:00", "special_hours_applied": false } ] }, { "day_of_week": "Thursday", "business_hours": [ { "open_time": "2025-02-06 11:00:00", "close_time": "2025-02-06 23:00:00", "special_hours_applied": false } ] }, { "day_of_week": "Friday", "business_hours": [ { "open_time": "2025-02-07 11:00:00", "close_time": "2025-02-08 00:00:00", "special_hours_applied": false } ] }, { "day_of_week": "Saturday", "business_hours": [ { "open_time": "2025-02-08 11:00:00", "close_time": "2025-02-09 00:00:00", "special_hours_applied": false } ] }, { "day_of_week": "Sunday", "business_hours": [ { "open_time": "2025-02-09 11:00:00", "close_time": "2025-02-09 23:00:00", "special_hours_applied": false } ] } ], "photos": [ { "original_url": "https://s3-media0.fl.yelpcdn.com/bphoto/o_RMV239sfg3g3F9TBw4uTzQg/o.jpg" }, { "original_url": "https://s3-media0.fl.yelpcdn.com/bphoto/o_RMV9asd3F9T4Bw4uTzQg/o.jpg" }, { "original_url": "https://s3-media0.fl.yelpcdn.com/bphoto/YkRk12fdaf3JUcQbdSpycQ/o.jpg" } ], "review_snippet": "It was the most [[HIGHLIGHT]]delicious pizza[[ENDHIGHLIGHT]] I ever had. It wasn't too loaded but it had everything it needed." } } ] } ], "chat_id": "-AfyyCgdgdTsQ23fkOg" } }, "Compare Sumo Sushi and ITs SUSHI in Las Vegas": { "value": { "chatId": "p2MbqlR1StvSjgDGdEA4HQ", "response": { "text": "Sumo Sushi and ITs SUSHI Spring Mountain are both popular for all-you-can-eat sushi in Las Vegas. Sumo Sushi is praised for its consistent high quality fish, excellent service, and affordable prices, with many reviewers calling it their new go-to spot. ITs SUSHI Spring Mountain is known for its creative rolls, good value, and a wide variety of AYCE options, though reviews mention inconsistent service and occasional mixed experiences with fish quality. Both offer great value, but Sumo Sushi stands out for its friendly, attentive staff and consistently fresh offerings.\n", "tags": [ { "start": 0, "end": 10, "tagType": "business", "meta": { "businessId": "Lc_l8k7YskzicRQ_8RtMyA" } }, { "start": 15, "end": 40, "tagType": "business", "meta": { "businessId": "myFPRndhdZMKdfMZyksyxQ" } }, { "start": 128, "end": 151, "tagType": "highlight", "meta": null }, { "start": 181, "end": 198, "tagType": "highlight", "meta": null }, { "start": 296, "end": 310, "tagType": "highlight", "meta": null }, { "start": 312, "end": 322, "tagType": "highlight", "meta": null }, { "start": 383, "end": 403, "tagType": "highlight", "meta": null }, { "start": 514, "end": 539, "tagType": "highlight", "meta": null } ] }, "entities": [ { "businesses": [ { "encid": "Lc_l8k7YskzicRQ_8RtMyA", "name": "Sumo Sushi", "alias": "sumo-sushi-las-vegas-2", "url": "https://www.yelp.com/biz/sumo-sushi-las-vegas-2?adjust_creative=ozhuoStXlSnOIK1pCpdsmg&utm_campaign=yelp_api_v3&utm_medium=api_v3_public_ai_api_chat_v2&utm_source=ozhuoStXlSnOIK1pCpdsmg", "price": "$$$", "categories": [ { "alias": "sushi", "title": "Sushi Bars" } ], "rating": 4.8, "location": null, "address1": "8795 W Warm Springs Rd", "address2": "Ste 105-106", "formattedAddress": "8795 W Warm Springs Rd\nSte 105-106\nLas Vegas, NV 89148", "address3": null, "city": "Las Vegas", "state": "NV", "zipCode": null, "country": "US", "coordinates": null, "latitude": 36.05520557246892, "longitude": -115.28334589829451, "reviewCount": 642, "contextualInfo": null, "summary": null, "reviewSnippet": "I love coming to [[HIGHLIGHT]]Sumo Sushi[[ENDHIGHLIGHT]]. This is my third time here. Sumo Sushi is hands down one of the best...", "reviewSnippets": [ { "reviewId": "6GjsTZoRiVvLkx6is4iEog", "comment": "So we've seen this place all over social media and it's around the corner from us so figured we'd give it a try. Our normal go to AYCE is It's sushi, and I'd say this place is on par with their [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] and selection. We went on a Saturday night around 630 expecting a bit of a wait, the hostess said about 30-45 mins, but we got a text in about 15 mins that our table was ready.", "rating": 5, "timestamp": null }, { "reviewId": "W9vVe9sa74XL6AIaL5l5vg", "comment": "So I knew coming to Sumo Sushi would have the same great [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] and options. My favorite type of sushi is tuna (all varieties but especially blue fin toro). You can't go wrong with anything on the menu. Our server Missy was the [[HIGHLIGHT]]best[[ENDHIGHLIGHT]]. She had great energy and guided us on the most popular items. She was on [[HIGHLIGHT]]top[[ENDHIGHLIGHT]] of everything and often checked on us without being overbearing.", "rating": 5, "timestamp": null }, { "reviewId": "-PE59b-lsHh5ToRUYbu2Og", "comment": "We've been regular sushi lovers in Las Vegas for years, and ever since Goyemon closed, we've been on the hunt for a new go-to spot. This is it. Not only does Sumo Sushi match the [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] of our old favorite, but in some ways--it's even better. Let's talk about the food- * The mussels are exceptional. We always order them, and they are easily some of the [[HIGHLIGHT]]best[[ENDHIGHLIGHT]] we've had anywhere in the city--rich, flavorful, and perfectly cooked", "rating": 5, "timestamp": null } ], "businessHours": [], "photos": [ { "originalUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/NrRBru8nYBS9lf20dWFvFw/o.jpg" }, { "originalUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/fquY0GQqQgMHN2yml7g9tQ/o.jpg" }, { "originalUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/GCyEEaz6c6TAhzc1AvdZqA/o.jpg" } ] }, { "encid": "myFPRndhdZMKdfMZyksyxQ", "name": "ITs SUSHI Spring Mountain", "alias": "its-sushi-spring-mountain-las-vegas-3", "url": "https://www.yelp.com/biz/its-sushi-spring-mountain-las-vegas-3?adjust_creative=ozhuoStXlSnOIK1pCpdsmg&utm_campaign=yelp_api_v3&utm_medium=api_v3_public_ai_api_chat_v2&utm_source=ozhuoStXlSnOIK1pCpdsmg", "price": "$$$", "categories": [ { "alias": "japanese", "title": "Japanese" }, { "alias": "sushi", "title": "Sushi Bars" }, { "alias": "buffets", "title": "Buffets" } ], "rating": 4.5, "location": null, "address1": "4815 Spring Mountain Rd", "address2": null, "formattedAddress": "4815 Spring Mountain Rd\nLas Vegas, NV 89103", "address3": "", "city": "Las Vegas", "state": "NV", "zipCode": null, "country": "US", "coordinates": null, "latitude": 36.1260493, "longitude": -115.2070253, "reviewCount": 2897, "contextualInfo": null, "summary": null, "reviewSnippet": "I knew [[HIGHLIGHT]]It's Sushi[[ENDHIGHLIGHT]] was new and figured it would be a great time to try it out.", "reviewSnippets": [ { "reviewId": "00q3Ax-1KAiT2rGa0Pygng", "comment": "I then ordered a roll, which comes out as a half roll for AYCE which is perfect. It too was presented well, with a great balance of natural and added flavor. The fish [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] is what blew my mind. [[HIGHLIGHT]]High quality[[ENDHIGHLIGHT]] fish doesn't come just from the fish being fresh. There is a lot more to it then that. It starts with the conditions it is caught, how quickly it is chilled, how carefully it is transported, how well it is stored, and how well its cut.", "rating": 5, "timestamp": null }, { "reviewId": "VHX4pSgUy2ZxR324eldKVg", "comment": "Call this place what you want to call it but it's overall a great dining experience. From the [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] of the food, to the random birthday shoutouts and the delicate care by the servers, Its Sushi is one of my to trusted spots in Vegas. You can tell the [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] of the fish is of the better [[HIGHLIGHT]]qualities[[ENDHIGHLIGHT]] from most spots in Vegas. Some Nigiri with soy sauce and wasabi will quench your sushi hunger here.", "rating": 5, "timestamp": null }, { "reviewId": "oCMd0GgapmhJIdpChFENOA", "comment": "Highlights: I personally had a great experience and was really surprised because I've tried my fair share of AYCE and part of me always regrets it since it's usually at the expense of [[HIGHLIGHT]]quality[[ENDHIGHLIGHT]] sushi. It's Sushi however still has pretty [[HIGHLIGHT]]good quality[[ENDHIGHLIGHT]] fish especially the salmon belly, uni, yellowtail and eel. They also had appetizers and items I hadn't seen at other AYCE places like hamburger steak, grilled saury, spring rolls, yubu, and cheese budak.", "rating": 4, "timestamp": null } ], "businessHours": [], "photos": [ { "originalUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/5OQj-6E-xC_FKJERHBQvrw/o.jpg" }, { "originalUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/Ddh9Iub86sGFwXvHyq8J4w/o.jpg" }, { "originalUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/NpRiNSVYF3w2jwGtpzaRYw/o.jpg" } ] } ] } ], "types": [ "business_question" ] } }, "Find me reservation for 2 people at Tuscany Steakhouse for July 12, 2025 at 7:00 PM": { "value": { "response": { "chat_id": "a14lrvvLkVsDbjUFI9wUQf", "text": "To book your table for 2 at Tuscany Steakhouse on Saturday, July 12, 2025 at 7:00 PM, I just need your first name, last name, email, and phone number. Please provide these details to complete your reservation.", "tags": [ { "tag_type": "business", "start": 28, "end": 46, "meta": { "business_id": "4WDHrSodF1Xidv9ezS6Sgg" } } ], "types": [ "reservation" ], "entities": [ { "businesses": [ { "id": "4WDHrSodF1Xidv9ezS6Sgg", "alias": "tuscany-steakhouse-new-york", "name": "Tuscany Steakhouse", "url": "https://www.yelp.com/biz/tuscany-steakhouse-new-york?adjust_creative=uKZbO3XxGEy7Htt5nSGiRw&utm_campaign=yelp_api_v3&utm_medium=api_v3_public_ai_api_chat_v2&utm_source=uKZbO3XxGEy7Htt5nSGiRw", "location": null, "address1": "117 W 58th St", "address2": null, "address3": null, "city": "New York", "zip_code": null, "state": "NY", "country": "US", "formatted_address": "117 W 58th St\nNew York, NY 10019", "coordinates": null, "latitude": 40.7654481, "longitude": -73.9773555, "review_count": 282, "price": "$$$", "rating": 4.6, "categories": [ { "alias": "steak", "title": "Steakhouses" }, { "alias": "italian", "title": "Italian" }, { "alias": "seafood", "title": "Seafood" } ], "attributes": { "BusinessAcceptsAndroidPay": false, "BusinessAcceptsApplePay": false, "BusinessUrl": "http://www.tuscanysteakhouse.com", "AboutThisBizBioPhotoDict": null, "AboutThisBizBusinessRecommendation": [], "AboutThisBizSpecialties": "Newest Steakhouse in Manhattan", "AboutThisBizYearEstablished": "2017", "Alcohol": "full_bar", "Ambience": { "divey": false, "hipster": false, "classy": true, "upscale": true }, "BikeParking": true, "BusinessAcceptsBitcoin": null, "BusinessAcceptsCreditCards": true, "BusinessDisplayUrl": null, "BusinessMovedTo": null, "BusinessParking": { "valet": false, "garage": true, "street": false, "lot": false, "validated": false }, "BYOB": null, "BYOBCorkage": null, "Caters": true, "Corkage": null, "DogsAllowed": false, "DriveThrstrooms": null, "GoodForKids": false, "GoodForMeal": { "dessert": true, "latenight": null, "lunch": null, "dinner": true, "brunch": null, "breakfast": null }, "HappyHour": null, "HasTV": true, "MenuUrl": null, "NationalProviderIdentifier": null, "NoiseLevel": "average", "RestaurantsAttire": "casual", "RestaurantsCounterService": null, "RestaurantsDelivery": true, "RestaurantsGoodForGroups": true, "RestaurantsPriceRange": null, "RestaurantsPriceRange2": 3, "RestaurantsReservations": true, "RestaurantsTableService": true, "RestaurantsTakeOut": true, "WaitlistReservation": true, "WheelchairAccessible": null, "WiFi": "free", "biz_summary": { "summary": "Classic steakhouse with a cozy atmosphere featuring perfectly cooked steaks.", "is_inactive": false, "allows_auto_summary_generation": true, "eligible_reviews_considered": 30 }, "biz_summary_long": { "summary": "Upscale steakhouse offering a blend of American and Italian cuisine, featuring dry-aged steaks and fresh seafood. Notable menu items include the Porterhouse for two and Filet Mignon, complemented by handcrafted cocktails and fine wines. The restaurant features a modern and intimate interior, with private dining options available for events. It is also accessible for guests with disabilities.", "is_inactive": false, "allows_auto_summary_generation": true, "eligible_reviews_considered": 68 }, "phone": "+12127578630", "summaries": { "short": "Classic steakhouse with a cozy atmosphere featuring perfectly cooked steaks.", "medium": "Upscale steakhouse offering a blend of American and Italian cuisine, featuring dry-aged steaks and fresh seafood. Notable menu items include the Porterhouse for two and Filet Mignon, complemented by handcrafted cocktails and fine wines. The restaurant features a modern and intimate interior, with private dining options available for events.", "long": "Upscale steakhouse offering a blend of American and Italian cuisine, featuring dry-aged steaks and fresh seafood. Notable menu items include the Porterhouse for two and Filet Mignon, complemented by handcrafted cocktails and fine wines. The restaurant features a modern and intimate interior, with private dining options available for events. It is also accessible for guests with disabilities." }, "contextual_info": { "summary": null, "review_snippets": [], "business_hours": [], "photos": [ { "original_url": "https://s3-media0.fl.yelpcdn.com/bphoto/-ntrLHjqTqc7-M-7YNsOoQ/o.jpg" }, { "original_url": "https://s3-media0.fl.yelpcdn.com/bphoto/kkLbCqRP_SmRh3K2uJmZMQ/o.jpg" }, { "original_url": "https://s3-media0.fl.yelpcdn.com/bphoto/i3eBkuB_wy0iA7_ldTOuOw/o.jpg" } ], "review_snippet": "Fantastic food and people. I highly recommend [[HIGHLIGHT]]Tuscany Steakhouse[[ENDHIGHLIGHT]]. We arrived in the City after...", "accepts_reservations_through_yelp": true, "reservation_availability": { "openings": [ { "date": "2025-07-12", "slots": [ { "time": "12:00", "seating_areas": [ "Indoor" ] }, { "time": "12:15", "seating_areas": [ "Indoor" ] }, { "time": "12:30", "seating_areas": [ "Indoor" ] }, { "time": "12:45", "seating_areas": [ "Indoor" ] }, { "time": "13:00", "seating_areas": [ "Indoor" ] }, { "time": "13:15", "seating_areas": [ "Indoor" ] }, { "time": "13:30", "seating_areas": [ "Indoor" ] }, { "time": "13:45", "seating_areas": [ "Indoor" ] }, { "time": "14:00", "seating_areas": [ "Indoor" ] }, { "time": "14:15", "seating_areas": [ "Indoor" ] }, { "time": "14:30", "seating_areas": [ "Indoor" ] }, { "time": "14:45", "seating_areas": [ "Indoor" ] }, { "time": "15:00", "seating_areas": [ "Indoor" ] }, { "time": "15:15", "seating_areas": [ "Indoor" ] }, { "time": "15:30", "seating_areas": [ "Indoor" ] }, { "time": "15:45", "seating_areas": [ "Indoor" ] }, { "time": "16:00", "seating_areas": [ "Indoor" ] }, { "time": "16:15", "seating_areas": [ "Indoor" ] }, { "time": "16:30", "seating_areas": [ "Indoor" ] }, { "time": "16:45", "seating_areas": [ "Indoor" ] }, { "time": "17:00", "seating_areas": [ "Indoor" ] }, { "time": "17:15", "seating_areas": [ "Indoor" ] }, { "time": "17:30", "seating_areas": [ "Indoor" ] }, { "time": "17:45", "seating_areas": [ "Indoor" ] }, { "time": "18:00", "seating_areas": [ "Indoor" ] }, { "time": "18:15", "seating_areas": [ "Indoor" ] }, { "time": "18:30", "seating_areas": [ "Indoor" ] }, { "time": "18:45", "seating_areas": [ "Indoor" ] }, { "time": "19:00", "seating_areas": [ "Indoor" ] }, { "time": "19:15", "seating_areas": [ "Indoor" ] }, { "time": "19:30", "seating_areas": [ "Indoor" ] }, { "time": "19:45", "seating_areas": [ "Indoor" ] }, { "time": "20:00", "seating_areas": [ "Indoor" ] }, { "time": "20:15", "seating_areas": [ "Indoor" ] }, { "time": "20:30", "seating_areas": [ "Indoor" ] }, { "time": "20:45", "seating_areas": [ "Indoor" ] }, { "time": "21:00", "seating_areas": [ "Indoor" ] }, { "time": "21:15", "seating_areas": [ "Indoor" ] }, { "time": "21:30", "seating_areas": [ "Indoor" ] }, { "time": "21:45", "seating_areas": [ "Indoor" ] }, { "time": "22:00", "seating_areas": [ "Indoor" ] }, { "time": "22:15", "seating_areas": [ "Indoor" ] } ] } ] } } } } ] } ] } } } } } } }, "400": { "description": "Bad Request. Message varies depending on failure scenario", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "description": "The error code." }, "description": { "type": "string", "description": "The description of the error." } } } } }, "examples": { "Invalid Request": { "value": { "error": { "code": "INVALID_REQUEST", "description": "Invalid Request" } } } } } } }, "401": { "description": "The API key has either expired or doesn't have the required scopes to query this endpoint.\n\n| code | description |\n| ------------- | ------------- |\n| UNAUTHORIZED_API_KEY | The API key provided is not currently able to query this endpoint. |\n| TOKEN_INVALID | Invalid API key or authorization header. |\n", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "error": { "code": "UNAUTHORIZED_API_KEY", "description": "The API key provided is not currently able to query this endpoint." } } }, "Invalid Token": { "value": { "error": { "code": "TOKEN_INVALID", "description": "Invalid API key or authorization header." } } } }, "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" } } } }, "403": { "description": "The API key provided is not currently able to query this endpoint.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}~1rapc_enabledness/post/responses/403" }, "404": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" }, "examples": { "Resource Not Found": { "value": { "error": { "code": "NOT_FOUND", "description": "Resource Not Found" } } } } } } }, "413": { "description": "The length of the request exceeded the maximum allowed", "content": { "application/json": { "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" }, "examples": { "Payload Too Large": { "value": { "error": { "code": "PAYLOAD_TOO_LARGE", "description": "Payload Too Large" } } } } } } }, "429": { "description": "You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "error": { "code": "TOO_MANY_REQUESTS_PER_SECOND", "description": "You have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries." } } } }, "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "examples": { "Internal Server Error": { "value": { "error": { "code": "INTERNAL_ERROR", "description": "Something went wrong internally, please try again later." } } } }, "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" }, "examples": { "Service Unavailable": { "value": { "error": { "code": "SERVICE_UNAVAILABLE", "description": "Service Unavailable" } } } } } } } } } }, "/v3/businesses/search": { "get": { "summary": "Search", "tags": [ "Businesses" ], "description": "This endpoint returns up to 240 businesses with some basic information based on the provided search criteria.\n\nExplore our new Yelp AI API for conversational search experiences. Try it for free in our playground and see real-time conversational responses in action.\n\n**Note:** The API does not return businesses without any reviews.\n", "operationId": "v3_business_search", "parameters": [ { "in": "query", "description": "Required if either *latitude* or *longitude* is not provided.\nThis string indicates the geographic area to be used when searching for businesses.\nExamples: \"New York City\", \"NYC\", \"350 5th Ave, New York, NY 10118\".\nBusinesses returned in the response may not be strictly within the specified location.\n", "required": false, "name": "location", "schema": { "type": "string", "minLength": 1, "maxLength": 250 } }, { "in": "query", "required": false, "description": "Required, if _location_ is not provided. Latitude of the location to search from. If latitude is provided, longitude is required too.", "name": "latitude", "schema": { "type": "number", "minimum": -90, "maximum": 90 } }, { "in": "query", "required": false, "description": "Required if _location_ is not provided. Longitude of the location to search from. If longitude is provided, latitude is required too.", "name": "longitude", "schema": { "type": "number", "minimum": -180, "maximum": 180 } }, { "name": "term", "in": "query", "description": "Search term, e.g. \"food\" or \"restaurants\".\nThe term may also be the business's name, such as \"Starbucks\". If term is not included the endpoint will default to searching across businesses from a small number of popular categories.\n", "required": false, "schema": { "type": "string", "maxLength": 300 } }, { "in": "query", "description": "A suggested search radius in meters. This field is used as a suggestion to the search. The actual search radius may be lower than the suggested radius in dense urban areas, and higher in regions of less business density.\nIf the specified value is too large, a AREA_TOO_LARGE error may be returned. The max value is 40,000 meters (about 25 miles).\n", "required": false, "name": "radius", "schema": { "type": "integer", "minimum": 0, "maximum": 40000 } }, { "in": "query", "description": "Categories to filter the search results with. See the list of supported categories. The category filter can be a list of comma delimited categories.\ne.g., \"bars,french\" will filter by Bars OR French.\nThe category alias should be used (e.g. \"discgolf\", not \"Disc Golf\").\n", "required": false, "name": "categories", "schema": { "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true } }, { "in": "query", "required": false, "name": "locale", "description": "Locale code in the format of {language code}_{country code}. See the [list of supported locales](https://docs.developer.yelp.com/docs/resources-supported-locales).\n", "schema": { "type": "string", "pattern": "^[a-z]{2,3}_[A-Z]{2}$" } }, { "in": "query", "required": false, "name": "price", "description": "Pricing levels to filter the search result with: 1 = $, 2 = $$, 3 = $$$, 4 = $$$$. The price filter can be a list of comma delimited pricing levels.\ne.g., \"1, 2, 3\" will filter the results to show the ones that are $, $$, or $$$.\n", "schema": { "type": "array", "maxItems": 4, "uniqueItems": true, "items": { "type": "integer", "minimum": 1, "maximum": 4 } } }, { "name": "open_now", "in": "query", "description": "When set to true, only return the businesses that are open now.\nNotice that _open_at_ and _open_now_ cannot be used together.\n", "required": false, "schema": { "type": "boolean" } }, { "name": "open_at", "in": "query", "description": "An integer representing the Unix time in the timezone of the search location. If specified, it will return businesses open at the given time.\nNotice that *open_at* and *open_now* cannot be used together.\n", "required": false, "schema": { "type": "integer" } }, { "name": "attributes", "in": "query", "description": "Try these additional filters to return specific search results!\n- *hot_and_new* - popular businesses which recently joined Yelp\n- *request_a_quote* - businesses which actively reply to Request a Quote inquiries\n- *reservation* - businesses with Yelp Reservations bookings enabled on their profile page\n- *waitlist_reservation* - businesses with Yelp _Wait List_ bookings enabled on their profile screen (iOS/Android)\n- *gender_neutral_restrooms* - businesses which provide gender neutral restrooms\n- *open_to_all* - businesses which are Open To All\n- *wheelchair_accessible* - businesses which are Wheelchair Accessible\n\n**Premium Search Filters, available to users with a [Yelp Places Premium Plan](https://business.yelp.com/data/products/fusion/):\n- *accepts_credit_cards* - businesses which accepts credit cards\n- Ambience\n - *ambience* - ambience of the business\n - *ambience_casual* - is the ambience at the business casual\n - *ambience_classy* - is the ambience at the business classy\n - *ambience_divey* - is the ambience at the business divey\n - *ambience_hipster* - is the ambience at the business hippy\n - *ambience_intimate* - is the ambience at the business intimate\n - *ambience_romantic* - is the ambience at the business romantic\n - *ambience_touristy* - is the ambience at the business touristy\n - *ambience_trendy* - is the ambience at the business trendy\n - *ambience_upscale* - is the ambience at the business upscale\n- *dogs_allowed* - dog-friendly businesses\n- *good_for_dancing* - businesses which are good for dancing\n- *happy_hour* - businesses which have happy hour specials\n- Liked by\n - *liked_by_beer* - businesses liked by people who drink beer\n - *liked_by_dates* - businesses liked by people who are on a date\n - *liked_by_fifties* - businesses liked by people who are in their fiftees\n - *liked_by_forties* - businesses liked by people who are in their forties\n - *liked_by_genx* - businesses liked by people who belong to Generation X\n - *liked_by_thirties* - businesses liked by people who are in their thirties\n - *liked_by_twenties* - businesses liked by people who are in their twenties\n - *liked_by_men* - businesses liked by men\n - *liked_by_students* - businesses liked by Students\n - *liked_by_travelers* - businesses liked by people who are travelling\n - *liked_by_vegetarians* - businesses which are liked by vegetarians\n - *liked_by_wine* - businesses liked by people who drink wine\n - *liked_by_women* - businesses liked by women\n - *liked_by_young_professionals* - businesses liked by young prefessionals\n- Noise level\n - *noise_level* - noise level at the business\n - *noise_level_average* - is the noise level average\n - *noise_level_loud* - is the noise level loud\n - *noise_level_quiet* - is the noise level quiet\n - *noise_level_very_loud* - is the noise level very loud\n- *outdoor_seating* - businesses with outdoor seating areas\n- Parking\n - *parking* - businesses with parking\n - *parking_garage* - businesses which itself has a garage or there is a parking garage nearby\n - *parking_lot* - businesses which have a parking lot\n - *parking_street* - businesses with street parking available nearby\n - *parking_valet* - businesses which offer a valet parking\n - *parking_validated* - businesses which can validate a parking ticket from an external parking\n - *parking_bike* - businesses with bike parking type\n- *restaurants_delivery* - restaurants which offer delivery service\n- *restaurants_takeout* - restaurants with take-out option\n- WiFi\n - *wifi* - businesses with WiFi\n - *wifi_free* - businesses with free WiFi\n - *wifi_paid* - businesses with paid WiFi\n\nYou can combine multiple attributes by providing a comma separated like \"attribute1,attribute2\".\nIf multiple attributes are used, only businesses that satisfy all the attributes will be returned in search results.\ne.g., the attributes \"*hot_and_new*,*request_a_quote*\" will return businesses that are 'Hot and New', and offer 'Request a Quote'.\n", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort_by", "in": "query", "description": "Suggestion to the search algorithm that the results be sorted by one of the these modes: *best_match*, *rating*, *review_count* or *distance*.\nThe default is *best_match*. Note that specifying the sort_by is a suggestion (not strictly enforced) to Yelp's search, which considers multiple input parameters to return the most relevant results.\n\ne.g., the *rating* sort is not strictly sorted by the rating value, but by an adjusted rating value that takes into account the number of ratings,\nsimilar to a Bayesian average. This is to prevent skewing results to businesses with a single review.\n", "required": false, "schema": { "type": "string", "default": "best_match", "enum": [ "best_match", "rating", "review_count", "distance" ] } }, { "in": "query", "required": false, "name": "device_platform", "description": "Determines the platform for mobile_link", "schema": { "type": "string", "enum": [ "android", "ios", "mobile-generic" ] } }, { "name": "reservation_date", "description": "The date for the reservation, format is YYYY-mm-dd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reservation_time", "description": "The time of the requested reservation, format is HH:MM", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reservation_covers", "description": "How many people are attending the reservation", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "matches_party_size_param", "in": "query", "description": "Whether to filter out results that don't have openings matching the params", "required": false, "schema": { "type": "boolean" } }, { "name": "job_alias", "in": "query", "description": "Return only businesses that service this job type (e.g. plumbing, HVAC repair).\nAcceptable job aliases can be found via the [Get Jobs](https://docs.developer.yelp.com/reference/v3_get_jobs) endpoint. If you need access to [Get Jobs](https://docs.developer.yelp.com/reference/v3_get_jobs), please [contact us](https://business.yelp.com/data/products/places-api/#form).\n", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of results to return.", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 0, "maximum": 50 } }, { "in": "query", "required": false, "name": "offset", "description": "Offset the list of returned results by this amount.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "One more more businesses were found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "businesses", "total", "region" ], "properties": { "businesses": { "type": "array", "items": { "type": "object", "description": "A Business Yelp finds based on the search criteria.", "required": [ "id", "alias", "name", "location", "coordinates", "phone", "display_phone" ], "properties": { "id": { "$ref": "#/paths/~1v3~1businesses~1engagement/get/responses/200/content/application~1json/schema/properties/data/items/properties/business_id" }, "alias": { "description": "Unique Yelp alias of this business. Can contain unicode characters.\nExample: 'yelp-san-francisco'. Also see What's the difference between the Yelp business ID and business alias?\n", "type": "string" }, "name": { "description": "Name of this business.", "type": "string" }, "image_url": { "description": "URL of photo for this business", "type": "string" }, "is_closed": { "description": "Whether business has been (permanently) closed", "type": "boolean" }, "url": { "description": "URL for business page on Yelp.", "type": "string" }, "review_count": { "description": "Number of reviews for this business.", "type": "integer" }, "categories": { "description": "List of category title and alias pairs associated with this business.", "type": "array", "items": { "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/responses/200/content/application~1json/schema/allOf/0/properties/categories/items" } }, "rating": { "description": "Rating for this business (value ranges from 1, 1.5, ... 4.5, 5).", "type": "decimal" }, "coordinates": { "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/responses/200/content/application~1json/schema/allOf/0/properties/coordinates" }, "transactions": { "description": "List of Yelp transactions that the business is registered for. Current supported values are **pickup**, **delivery** and **restaurant_reservation**.", "type": "array", "items": { "type": "string" } }, "price": { "description": "Price level of the business. Uses the currency symbol of the provided locale. Value for en_US is one of *$*, *$$*, *$$$* or *$$$$*.", "type": "string" }, "location": { "description": "Location of this business, including address, city, state, zip code and country.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/responses/200/content/application~1json/schema/allOf/0/properties/location" }, "phone": { "description": "Phone number of the business.", "type": "string" }, "display_phone": { "description": "Phone number of the business formatted nicely to be displayed to users. The format is the standard phone number format for the business's country.", "type": "string" }, "distance": { "description": "Distance in meters from the search location. This value is in meters(m) regardless of the locale.", "type": "decimal" }, "attributes": { "description": "Various features or facilities provided by the business.\n**Yelp Places Premium tier** attributes, please apply [here](https://business.yelp.com/data/products/fusion/):\n* *liked_by_vegetarians* - is the business liked by vegetarians\n* *liked_by_vegans* - is the business liked by vegans\n* *hot_and_new* - has the business recently joined Yelp\n", "type": "object" }, "business_hours": { "type": "array", "description": "Regular business hours.\n", "items": { "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/responses/200/content/application~1json/schema/allOf/1/properties/hours/items" } } } } }, "total": { "description": "Total number of businesses Yelp finds based on the search criteria. Sometimes, the value may exceed 240. In such case, you still can only get up to 240 businesses using multiple queries and combinations of the \"limit\" and \"offset\" parameters.\n", "type": "integer" }, "region": { "description": "Suggested area in a map to display results in.", "type": "object", "required": [ "center" ], "properties": { "center": { "description": "Center location of the region.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/responses/200/content/application~1json/schema/allOf/0/properties/coordinates" } } } } }, "examples": { "Result": { "value": { "businesses": [ { "alias": "golden-boy-pizza-hamburg", "categories": [ { "alias": "pizza", "title": "Pizza" }, { "alias": "food", "title": "Food" } ], "coordinates": { "latitude": 41.7873382568359, "longitude": -123.051551818848 }, "display_phone": "(415) 982-9738", "distance": 4992.437696561071, "id": "QPOI0dYeAl3U8iPM_IYWnA", "image_url": "https://yelp-photos.yelpcorp.com/bphoto/b0mx7p6x9Z1ivb8yzaU3dg/o.jpg", "is_closed": true, "location": { "address1": "James", "address2": "Street", "address3": "68M", "city": "Los Angeles", "country": "US", "display_address": [ "James", "Street", "68M", "Los Angeles, CA 22399" ], "state": "CA", "zip_code": "22399" }, "name": "Golden Boy Pizza", "phone": "+14159829738", "price": "$", "rating": 4, "review_count": 903, "transactions": [ "restaurant_reservation" ], "url": "https://www.yelp.com/biz/golden-boy-pizza-hamburg?adjust_creative=XsIsNkqpLmHqfJ51zfRn3A&utm_campaign=yelp_api_v3&utm_medium=api_v3_business_search&utm_source=XsIsNkqpLmHqfJ51zfRn3A", "business_hours": { "open": [ { "is_overnight": false, "start": 15, "end": 130, "day": 0 }, { "is_overnight": false, "start": 630, "end": 1730, "day": 1 }, { "is_overnight": false, "start": 45, "end": 500, "day": 2 } ], "hours_type": "REGULAR", "is_open_now": false } } ], "region": { "center": { "latitude": 37.76089938976322, "longitude": -122.43644714355469 } }, "total": 6800 } } } } } }, "400": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400" }, "401": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/401" }, "403": { "description": "The API key provided is not currently able to query this endpoint.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}~1rapc_enabledness/post/responses/403" }, "404": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/404" }, "413": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/413" }, "429": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/429" }, "500": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/500" }, "503": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/503" } } } }, "/v3/businesses/search/phone": { "get": { "summary": "Phone Search", "tags": [ "Businesses" ], "description": "This endpoint returns a list of businesses based on the provided phone number. It is possible for more than one business to have the same phone number (for example, chain stores with the same +1 800 phone number).\n\nNote: at this time, the API does not return businesses without any reviews.\n", "operationId": "v3_business_phone_search", "parameters": [ { "name": "phone", "in": "query", "description": "Phone number of the business you want to search for. It must start with + and include the country code, like +14159083801.", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[0-9 +()-.x/]+$" } }, { "$ref": "#/paths/~1v3~1businesses~1search/get/parameters/6", "in": "query", "required": false } ], "responses": { "200": { "description": "One more more businesses were found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "businesses", "total" ], "properties": { "businesses": { "type": "array", "items": { "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/responses/200/content/application~1json/schema/allOf/0" } }, "total": { "$ref": "#/paths/~1v3~1businesses~1search/get/responses/200/content/application~1json/schema/properties/total" } } }, "examples": { "Result": { "value": { "businesses": [ { "alias": "golden-boy-pizza-hamburg", "categories": [ { "alias": "pizza", "title": "Pizza" }, { "alias": "food", "title": "Food" } ], "coordinates": { "latitude": 41.7873382568359, "longitude": -123.051551818848 }, "display_phone": "(415) 982-9738", "distance": 4992.437696561071, "id": "QPOI0dYeAl3U8iPM_IYWnA", "image_url": "https://yelp-photos.yelpcorp.com/bphoto/b0mx7p6x9Z1ivb8yzaU3dg/o.jpg", "is_closed": true, "location": { "address1": "James", "address2": "Street", "address3": "68M", "city": "Los Angeles", "country": "US", "display_address": [ "James", "Street", "68M", "Los Angeles, CA 22399" ], "state": "CA", "zip_code": "22399" }, "name": "Golden Boy Pizza", "phone": "+14159829738", "rating": 4, "review_count": 903, "transactions": [ "restaurant_reservation" ], "url": "https://www.yelp.com/biz/golden-boy-pizza-hamburg?adjust_creative=XsIsNkqpLmHqfJ51zfRn3A&utm_campaign=yelp_api_v3&utm_medium=api_v3_business_search&utm_source=XsIsNkqpLmHqfJ51zfRn3A" } ], "total": 1 } } } } } }, "400": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400" }, "401": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/401" }, "403": { "description": "The API key provided is not currently able to query this endpoint.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}~1rapc_enabledness/post/responses/403" }, "404": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/404" }, "413": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/413" }, "429": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/429" }, "500": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/500" }, "503": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/503" } } } }, "/v3/businesses/{business_id_or_alias}": { "get": { "summary": "Business Details", "tags": [ "Businesses" ], "description": "This endpoint returns detailed business content.\nNormally, you would get the Business ID from [/v3/businesses/search](https://docs.developer.yelp.com/reference/v3_business_search), [/v3/businesses/search/phone](https://docs.developer.yelp.com/reference/v3_business_phone_search), [/v3/transactions/{transaction_type}/search](https://docs.developer.yelp.com/reference/v3_transaction_search) or [/v3/autocomplete](https://docs.developer.yelp.com/reference/v3_autocomplete).\nTo retrieve review excerpts for a business, please refer to our Reviews endpoint ([/v3/businesses/{id}/reviews](https://docs.developer.yelp.com/reference/v3_business_reviews))\n\n**Note:** at this time, the API does not return businesses without any reviews.\n", "operationId": "v3_business_info", "parameters": [ { "in": "path", "required": true, "name": "business_id_or_alias", "description": "A unique identifier for a Yelp Business. Can be either a 22-character Yelp Business ID, or a Yelp Business Alias.", "schema": { "type": "string" } }, { "$ref": "#/paths/~1v3~1businesses~1search/get/parameters/6", "in": "query", "required": false }, { "$ref": "#/paths/~1v3~1businesses~1search/get/parameters/12", "in": "query", "required": false } ], "responses": { "200": { "description": "A Business with the requested Id was returned.", "content": { "application/json": { "schema": { "description": "A full representation of a business", "type": "object", "required": [ "is_claimed", "photos", "hours" ], "allOf": [ { "type": "object", "description": "A Business Yelp finds based on the search criteria.", "required": [ "id", "alias", "name", "location", "coordinates", "phone", "display_phone" ], "properties": { "id": { "$ref": "#/paths/~1v3~1businesses~1engagement/get/responses/200/content/application~1json/schema/properties/data/items/properties/business_id" }, "alias": { "description": "Unique Yelp alias of this business. Can contain unicode characters.\nExample: 'yelp-san-francisco'. Also see What's the difference between the Yelp business ID and business alias?\n", "type": "string" }, "name": { "description": "Name of this business.", "type": "string" }, "image_url": { "description": "URL of photo for this business", "type": "string" }, "is_closed": { "description": "Whether business has been (permanently) closed", "type": "boolean" }, "url": { "description": "URL for business page on Yelp.", "type": "string" }, "review_count": { "description": "Number of reviews for this business.", "type": "integer" }, "categories": { "description": "List of category title and alias pairs associated with this business.", "type": "array", "items": { "description": "A list of Yelp Categories.", "type": "array", "items": { "type": "object", "description": "Category that the business falls in.", "required": [ "alias", "title" ], "properties": { "alias": { "description": "Alias of a category, when searching for business in certain categories, use alias rather than the title.", "type": "string" }, "title": { "description": "Title of a category for display purpose.", "type": "string" } } } } }, "rating": { "description": "Rating for this business (value ranges from 1, 1.5, ... 4.5, 5).", "type": "decimal" }, "coordinates": { "type": "object", "description": "Coordinates of this business.", "required": [ "latitude", "longitude" ], "properties": { "latitude": { "description": "Latitude position on map.", "type": "decimal" }, "longitude": { "description": "Longitude position on map.", "type": "decimal" } } }, "transactions": { "description": "List of Yelp transactions that the business is registered for. Current supported values are **pickup**, **delivery** and **restaurant_reservation**.", "type": "array", "items": { "type": "string" } }, "price": { "description": "Price level of the business. Uses the currency symbol of the provided locale. Value for en_US is one of *$*, *$$*, *$$$* or *$$$$*.", "type": "string" }, "location": { "description": "Location of this business, including address, city, state, zip code and country.", "type": "object", "required": [ "display_address" ], "properties": { "address1": { "description": "Street address of this business.", "type": "string" }, "address2": { "description": "Street address of this business, continued.", "type": "string" }, "address3": { "description": "Street address of this business, continued.", "type": "string" }, "city": { "description": "City of this business.", "type": "string" }, "zip_code": { "description": "[Zip code](https://en.wikipedia.org/wiki/Postal_code) of this business.", "type": "string" }, "country": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of this business.", "type": "string" }, "state": { "description": "[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) (with a few [exceptions](https://docs.developer.yelp.com/docs/resources-state-codes)) state code of this business.", "type": "string" }, "display_address": { "description": "Array of strings that if organized vertically give an address that is in the standard address format for the business's country.", "type": "array", "items": { "type": "string" } }, "cross_streets": { "type": "string", "description": "Cross streets of this address", "nullable": true } } }, "phone": { "description": "Phone number of the business.", "type": "string" }, "display_phone": { "description": "Phone number of the business formatted nicely to be displayed to users. The format is the standard phone number format for the business's country.", "type": "string" }, "distance": { "description": "Distance in meters from the search location. This value is in meters(m) regardless of the locale.", "type": "decimal" }, "attributes": { "description": "Various features or facilities provided by the business.\n**Yelp Places Premium tier** attributes, please apply [here](https://business.yelp.com/data/products/fusion/):\n* *liked_by_vegetarians* - is the business liked by vegetarians\n* *liked_by_vegans* - is the business liked by vegans\n* *hot_and_new* - has the business recently joined Yelp\n", "type": "object" } } }, { "type": "object", "properties": { "is_claimed": { "type": "boolean", "description": "Whether business has been claimed by a business owner" }, "date_opened": { "type": "string", "description": "Business opening date" }, "date_closed": { "type": "string", "description": "Business closing date" }, "photos": { "type": "array", "description": "URLs of up to three photos of the business.

URLs of up to twelve photos of the business are available for **[Yelp Places Premium tier](https://business.yelp.com/data/products/fusion/)** users

", "items": { "type": "string" } }, "special_hours": { "type": "array", "description": "Out of the ordinary hours for the business that apply on certain dates. Whenever these are set, they will override the regular business hours found in the 'hours' field.", "items": { "type": "object", "required": [ "date" ], "properties": { "date": { "type": "string", "format": "date", "description": "An [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date string representing the date for which these special hours apply." }, "start": { "type": "string", "description": "Start of the opening hours in a day, in [24-hour clock](https://en.wikipedia.org/wiki/24-hour_clock) notation, like 1000 means 10 AM." }, "end": { "type": "string", "description": "End of the opening hours in a day, in [24-hour clock](https://en.wikipedia.org/wiki/24-hour_clock) notation, like 2130 means 9:30 PM." }, "is_overnight": { "type": "boolean", "description": "Whether the special hours time range spans across midnight or not. When this is true, the end time will be lower than the start time." }, "is_closed": { "type": "boolean", "description": "Whether this particular special hour represents a date where the business is closed." } } } }, "messaging": { "type": "object", "description": "Information and action links for messaging with this business via Yelp, including requesting quotes.", "required": [ "url", "use_case_text" ], "properties": { "url": { "type": "string", "description": "Visit this action link URL to go directly into the business messaging flow for this business." }, "use_case_text": { "type": "string", "description": "Indicates what kind of messaging can be done with the business.\ne.g., \"Request a Quote\" for a home services business, or \"Request a Consultation\" for a legal services business. This text will be localized (see Localization).\n" }, "response_rate": { "type": "float", "description": "Float number between 0 and 1, where 0 is never replies and 1 is always replies.

Yelp Places Premium tier, please apply [here](https://business.yelp.com/data/products/fusion/)

" }, "response_time": { "type": "integer", "description": "Estimated response time in seconds.

Yelp Places Premium tier, please apply [here](https://business.yelp.com/data/products/fusion/)

" }, "is_enabled": { "type": "boolean", "description": "Whether messaging is currently enabled. Access is disabled by default. See [Yelp Partner APIs](https://docs.developer.yelp.com/docs/yelp-partner-apis) on how to get access." } } }, "photo_count": { "type": "integer", "description": "Total number of photos

Yelp Places Premium tier, please apply [here](https://business.yelp.com/data/products/fusion/)

" }, "photo_details": { "type": "array", "description": "List of photo details

Yelp Places Premium tier, please apply [here](https://business.yelp.com/data/products/fusion/)

", "items": { "type": "object", "properties": { "photo_id": { "type": "string", "description": "Unique identifier for a photo" }, "url": { "type": "string", "description": "Photo URL" }, "caption": { "type": "string", "description": "Photo caption" }, "width": { "type": "integer", "description": "Photo width" }, "height": { "type": "integer", "description": "Photo height" }, "is_user_submitted": { "type": "boolean", "description": "Photo submitted by user" }, "user_id": { "type": "string", "description": "Unique identifier for a user" }, "label": { "type": "string", "description": "Photo label" } } } }, "yelp_menu_url": { "type": "string", "description": "Business menu URL

Yelp Places Premium tier, please apply [here](https://business.yelp.com/data/products/fusion/)

" }, "cbsa": { "type": "string", "description": "Core based statistical area.

Yelp Insights Premium attribute, please apply [here](https://business.yelp.com/data/products/fusion-insights/)

" }, "popularity_score": { "type": "object", "description": "Indicates popularity of a business with respect to other businesses belonging to the same primary category.

Yelp Insights Premium attributes, please apply [here](https://business.yelp.com/data/products/fusion-insights/)

", "properties": { "primary_category": { "type": "string", "description": "Business primary category" }, "score": { "type": "float", "description": "Popularity score" } } }, "rapc": { "type": "object", "description": "Information about Request a Phone Call for this business. Access is disabled by default. See [Yelp Partner APIs](https://docs.developer.yelp.com/docs/yelp-partner-apis) on how to get access.", "properties": { "is_enabled": { "type": "boolean", "description": "Whether Request a Phone Call is currently enabled. Request a Phone Call can be toggled via the [Enable/Disable Request a Phone Call endpoint](https://docs.developer.yelp.com/reference/v3_business_rapc_enabledness)." }, "is_eligible": { "type": "boolean", "description": "Whether the given business is eligible for Request a Phone Call. The [Enable/Disable Request a Phone Call endpoint](https://docs.developer.yelp.com/reference/v3_business_rapc_enabledness) can only be used if the business is eligible." } } }, "raq": { "type": "object", "description": "Information about Request a Quote for this business. Access is disabled by default. See [Yelp Partner APIs](https://docs.developer.yelp.com/docs/yelp-partner-apis) on how to get access.", "properties": { "is_enabled": { "type": "boolean", "description": "Whether Request a Quote is currently enabled." } } }, "licenses": { "type": "array", "description": "List of verified licenses for the business.\nAccess is disabled by default. To have access, please [contact us](https://business.yelp.com/data/products/places-api/#form).\n", "items": { "type": "object", "description": "Verified professional license information for a business.", "properties": { "license_type": { "type": "string", "description": "The type or category of the license." }, "verification_date": { "type": "string", "description": "The date the license was verified by Yelp (YYYY-MM-DD)." }, "expiration_date": { "type": "string", "description": "The license expiration date (YYYY-MM-DD)." }, "issuing_authority": { "type": "string", "description": "The authority or agency that issued the license." }, "license_number": { "type": "string", "description": "The license identification number." } } } }, "hours": { "type": "array", "description": "Regular business hours.\n", "items": { "type": "object", "required": [ "hour_type", "open", "is_open_now" ], "properties": { "hour_type": { "type": "string", "description": "Type of business hours" }, "open": { "type": "array", "description": "List of open hours", "items": { "type": "object", "required": [ "is_overnight", "start", "end", "day" ], "properties": { "day": { "type": "integer", "description": "Day of the week." }, "start": { "type": "string", "description": "Start of the opening hours in a day, in [24-hour clock](https://en.wikipedia.org/wiki/24-hour_clock) notation, like 1000 means 10 AM." }, "end": { "type": "string", "description": "End of the opening hours in a day, in [24-hour clock](https://en.wikipedia.org/wiki/24-hour_clock) notation, like 2130 means 9:30 PM." }, "is_overnight": { "type": "boolean", "description": "Whether the special hours time range spans across midnight or not. When this is true, the end time will be lower than the start time." } } } }, "is_open_now": { "type": "boolean", "description": "Whether the business is open now" } } } }, "online_reservation": { "type": "object", "description": "Present when the business supports online reservations through Yelp.", "properties": { "url": { "type": "string", "description": "Link to the reservation page for this business, where users can select a date, time, and party size to book a table." } } } } } ] }, "examples": { "Result": { "value": { "alias": "golden-boy-pizza-hamburg", "categories": [ { "alias": "pizza", "title": "Pizza" }, { "alias": "food", "title": "Food" } ], "coordinates": { "latitude": 41.7873382568359, "longitude": -123.051551818848 }, "display_phone": "(415) 982-9738", "distance": 4992.437696561071, "id": "QPOI0dYeAl3U8iPM_IYWnA", "image_url": "https://yelp-photos.yelpcorp.com/bphoto/b0mx7p6x9Z1ivb8yzaU3dg/o.jpg", "is_claimed": false, "is_closed": true, "date_opened": "", "date_closed": "", "location": { "address1": "James", "address2": "Street", "address3": "68M", "city": "Los Angeles", "country": "US", "display_address": [ "James", "Street", "68M", "Los Angeles, CA 22399" ], "state": "CA", "zip_code": "22399" }, "name": "Golden Boy Pizza", "phone": "+14159829738", "photos": [ "https://s3-media2.fl.yelpcdn.com/bphoto/CPc91bGzKBe95aM5edjhhQ/o.jpg", "https://s3-media4.fl.yelpcdn.com/bphoto/FmXn6cYO1Mm03UNO5cbOqw/o.jpg", "https://s3-media4.fl.yelpcdn.com/bphoto/HZVDyYaghwPl2kVbvHuHjA/o.jpg" ], "photo_details": [ { "photo_id": "CPc91bGzKBe95aM5edjhhQ", "url": "https://s3-media2.fl.yelpcdn.com/bphoto/CPc91bGzKBe95aM5edjhhQ/o.jpg", "caption": "Meat", "width": "710,", "height": "47,", "is_user_submitted": "false,", "user_id": "null,", "label": "food" }, { "photo_id": "FmXn6cYO1Mm03UNO5cbOqw", "url": "https://s3-media4.fl.yelpcdn.com/bphoto/FmXn6cYO1Mm03UNO5cbOqw/o.jpg", "caption": "Dessert", "width": 585, "height": 78, "is_user_submitted": false, "user_id": "null,", "label": "food" }, { "photo_id": "HZVDyYaghwPl2kVbvHuHjA", "url": "https://s3-media4.fl.yelpcdn.com/bphoto/HZVDyYaghwPl2kVbvHuHjA/o.jpg", "caption": "Dessert_2", "width": 710, "height": 53, "is_user_submitted": false, "user_id": null, "label": "food" } ], "photo_count": 50, "price": "$", "rating": 4, "review_count": 903, "hours": { "open": [ { "is_overnight": false, "start": 15, "end": 130, "day": 0 }, { "is_overnight": false, "start": 630, "end": 1730, "day": 1 }, { "is_overnight": false, "start": 45, "end": 500, "day": 2 } ], "hours_type": "REGULAR", "is_open_now": false }, "special_hours": [ { "date": "2019-02-07", "end": "2000", "is_closed": null, "is_overnight": false, "start": "1600" } ], "transactions": [ "restaurant_reservation" ], "url": "https://www.yelp.com/biz/golden-boy-pizza-hamburg?adjust_creative=XsIsNkqpLmHqfJ51zfRn3A&utm_campaign=yelp_api_v3&utm_medium=api_v3_business_search&utm_source=XsIsNkqpLmHqfJ51zfRn3A", "attributes": { "business_temp_closed": 1657868400, "outdoor_seating": false, "liked_by_vegans": false, "liked_by_vegetarians": true, "hot_and_new": "2022-12-10" }, "messaging": { "url": "https://www.yelp.com/raq/AA5cAADa-F9f5DPqZ-PADA?adjust_creative=5374ujususZtKiSNEg7uhg&utm_campaign=yelp_api_v3&utm_medium=api_v3_graphql&utm_source=5374upadasZtCvMLBg7uhg#popup%3Araq", "use_case_text": "Request a Quote", "response_rate": 1, "response_time": 791, "is_enabled": true }, "yelp_menu_url": "https://www.yelp.com/menu/golden-boy-pizza-hamburg", "rapc": { "is_enabled": true, "is_eligible": true }, "raq": { "is_enabled": true }, "online_reservation": { "url": "https://www.yelp.com/rez/golden-boy-pizza-hamburg" } } } } } } }, "400": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400" }, "401": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/401" }, "403": { "description": "The API key provided is not currently able to query this endpoint.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}~1rapc_enabledness/post/responses/403" }, "404": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/404" }, "413": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/413" }, "429": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/429" }, "500": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/500" }, "503": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/503" } } } }, "/v3/businesses/engagement": { "get": { "summary": "Engagement Metrics", "tags": [ "Businesses" ], "description": "Returns engagement metrics information for the provided businesses.\n
\n This endpoint requires special permissions to be enabled for your Yelp Places API Key.\n
\n", "operationId": "v3_get_businesses_engagement", "parameters": [ { "name": "business_ids", "description": "Business Id or alias of the businesses for which to get data.", "in": "query", "required": true, "schema": { "type": "array", "maxItems": 20, "items": { "type": "string" } } }, { "name": "date_range_start", "description": "Start of the date range during which to get metrics. Defaults to the beginning of the most recently available week.", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "date_range_end", "description": "End of the date range during which to get metrics. Defaults to the end of the most recently available week.", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Engagement metrics for one or more businesses were returned.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "metrics" ], "properties": { "business_id": { "type": "string", "description": "Yelp Encrypted Business ID." }, "metrics": { "type": "array", "items": { "type": "object", "required": [ "start_of_week_date" ], "properties": { "start_of_week_date": { "type": "string", "description": "Start date of the week for which metrics was requested.", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "engagement_metric": { "type": "integer", "description": "Score on a scale of 1-20 to measure consumer engagement of a particular business" }, "intent_metric": { "type": "integer", "description": "Score on a scale of 1-10 to measure consumer intent of a particular business" }, "transaction_metric": { "type": "integer", "description": "Score on a scale of 1-4 to measure consumer transaction with a particular business" } } } } } } } } }, "examples": { "Result": { "value": { "data": [ { "business_id": "w-WAiKJe__oZV13M34pTFw", "metrics": [ { "start_of_week_date": "2022-10-17", "engagement_metric": 20, "intent_metric": 10, "transaction_metric": 1 }, { "start_of_week_date": "2021-08-30", "engagement_metric": 20, "intent_metric": 10, "transaction_metric": 3 } ] } ] } } } } } }, "400": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400" }, "401": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/401" }, "403": { "description": "The API key provided is not currently able to query this endpoint.", "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}~1rapc_enabledness/post/responses/403" }, "404": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/404" }, "413": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/413" }, "429": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/429" }, "500": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/500" }, "503": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/503" } } } }, "/v3/businesses/{business_id_or_alias}/rapc_enabledness": { "post": { "summary": "Enable/Disable Request a Phone Call", "tags": [ "Businesses" ], "description": "This endpoint lets you enable or disable Request a Phone Call for a particular business. Check whether the business is eligible using the [Get business by ID](https://docs.developer.yelp.com/reference/v3_business_info) endpoint and inspecting the *rapc* object.\n\n*Example*:\nTo enable Request a Phone call for a Business with ID \"loPSlzp6M628rzyCRPqrv3tC\", send an [authenticated](https://docs.developer.yelp.com/docs/authorization-code-workflow) POST request to the URL:\nhttps://api.yelp.com/v3/businesses/loPSlzp6M628rzyCRPqrv3tC/rapc_enabledness with the following request body:\n\n```json\n{\n \"is_enabled\": true,\n}\n```\n\nFor the above request, a successful POST call will return a 202 accepted response.\n", "operationId": "v3_business_rapc_enabledness", "security": [ { "oauth2": [ "leads" ] } ], "parameters": [ { "$ref": "#/paths/~1v3~1businesses~1{business_id_or_alias}/get/parameters/0", "in": "path", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "is_enabled": { "type": "boolean", "description": "Whether RaPC should be enabled" } }, "required": [ "is_enabled" ] } } } }, "responses": { "202": { "description": "The RaPC status has been set." }, "400": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400" }, "401": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/401" }, "403": { "description": "Authorization Error", "content": { "application/json": { "schema": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/400/content/application~1json/schema" }, "examples": { "Authorization Error": { "value": { "error": { "code": "AUTHORIZATION_ERROR", "description": "Authorization Error" } } } } } } }, "404": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/404" }, "413": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/413" }, "429": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/429" }, "500": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/500" }, "503": { "$ref": "#/paths/~1ai~1chat~1v2/post/responses/503" } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": false, "samples-enabled": true }, "_id": { "buffer": { "0": 99, "1": 106, "2": 66, "3": 36, "4": 165, "5": 116, "6": 255, "7": 5, "8": 106, "9": 241, "10": 2, "11": 128 } } } ````