Skip to main content
GET
Yelp Business Reviews
Return up to ten Yelp reviews in source relevance order. The opaque cursor is bound to the business and date filters and advances by ten source rows, even if filtering removes all rows. At most 101 pages are available. Date filters apply to each returned page, not an exhaustive archive; undated rows are retained. Yelp review IDs and unknown sentiment remain null. AI enrichment is unavailable. Successful uncached requests cost 5 credits. Cache hits and failed requests cost zero. Provider availability and free allowance may change.

Authorizations

x-api-key
string
header
required

Headers

Cache-Control
string
Idempotency-Key
string
X-Max-Credits
integer

Optional nonnegative integer cap on the maximum request hold. A live request whose hold exceeds this cap returns 422 CREDIT_BUDGET_EXCEEDED before spending. Metered holds use the requested limit; cache hits and successful idempotent replays cost zero.

Required range: x >= 0

Query Parameters

id
string

22-character Yelp business ID (encid). Aliases are unsupported.

url
string

Canonical HTTPS URL containing the product ID or 22-character Yelp business ID. Query strings, fragments and aliases are unsupported.

cursor
string

Opaque next_cursor from the previous page. Keep business and date filters identical.

label
string

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

reports
string

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

judgments
enum<string>

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

Available options:
on,
off
dry_run
enum<string>

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

Available options:
1
label_evidence
enum<string>

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

Available options:
1
fit
enum<string>

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

Available options:
goal
goal
string

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

fit_tokens
integer

AI enrichment is unavailable. Omit this parameter; only judgments=off is accepted. Unsupported enrichment requests fail with 422 and no charge.

since
string

YYYY-MM-DD or an ISO timestamp with explicit timezone. Filters only the returned source page. Date-only until includes the entire UTC day; undated rows remain.

until
string

YYYY-MM-DD or an ISO timestamp with explicit timezone. Filters only the returned source page. Date-only until includes the entire UTC day; undated rows remain.

Response

Return up to ten Yelp reviews in source relevance order. The opaque cursor is bound to the business and date filters and advances by ten source rows, even if filtering removes all rows. At most 101 pages are available. Date filters apply to each returned page, not an exhaustive archive; undated rows are retained. Yelp review IDs and unknown sentiment remain null. AI enrichment is unavailable.

success
boolean
required
platform
string
required
endpoint
string
required
credits_used
integer
required
Required range: x >= 0
credits_remaining
integer | null
required
request_id
string
required
cached
boolean
required
data
object
required

The selected operation determines the resource fields in this object. Source data can omit a metric or report it as null.