---
title: "Get business details from Yelp"
method: POST
path: "/yelp/get-business"
tags: ["Yelp"]
---

# Get business details from Yelp

`POST /yelp/get-business`

## Request

- Base URL: `https://api.exfunc.dev`
- URL: `https://api.exfunc.dev/yelp/get-business`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/carvedai/apis/exfunc-apis/docs/yelp/get-business/post.ts> (a function with typed inputs; its response is checked against the schema)

Get business details from Yelp for a given business ID

## Request body

- object
  - `business_id` string, required: The ID of the business to retrieve reviews for

## Response `200`

GetBusiness API successful response

- object
  - `business` YelpBusiness
    - `business_id` string: Unique identifier for the business
    - `alias` string: A unique identifier used in the URL for the business
    - `name` string: The name of the business
    - `address` string: The physical address of the business
    - `website` string, uri: The website URL of the business
    - `business_page_link` string, uri: The link to the business's page on the platform
    - `categories` object[]: List of categories that the business falls under
      - `title` string
      - `url` string
    - `rating` number, float: Average rating of the business
    - `review_count` integer: Total number of reviews for the business
    - `highlights` string[]: Highlights or features of the business
    - `service_area` string: The area where the business provides services
    - `neighborhoods` string[]: List of neighborhoods where the business is located

## Other responses

- `400`: User error response
- `500`: Server error response

---

[API](https://skmtc.dev/carvedai/apis/exfunc-apis.md) - [All operations](https://skmtc.dev/carvedai/apis/exfunc-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/carvedai/apis/exfunc-apis/revisions/22587fdf9a5e?raw)