place_idstringrequired
Encoded Yelp business ID: letters, numbers, underscores, and hyphens.
Start building
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/yelp/reviews" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"hl": "en",
"num": 10,
"start": 0,
"sortby": "relevance_desc",
"place_id": "dDz2erKJ_Z2HMur0tQ_iJA",
"not_recommended": false
}
SANDBASE_JSON
)
printf '%s\n' "$result"Set your SandBase API key in your server environment. Requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep your key on the server. Do not expose it in browser code.
place_idstringrequiredEncoded Yelp business ID: letters, numbers, underscores, and hyphens.
yelp_domainstringSupported first-party localized Yelp hostname, such as www.yelp.co.uk. Links in the response use this hostname.
hlstringReview language: a two-letter code with an optional two-letter region, such as en or fr-FR.
Default: "en"
qstringNot supported: Yelp does not offer review text filtering. Any value returns 422 unsupported_parameter.
sortbystringReview order.
Default: "relevance_desc"
Possible values: relevance_desc, date_desc, date_asc, rating_desc, rating_asc, elites_desc
ratingstringComma-separated star ratings to include, each from 1 through 5.
not_recommendedbooleanNot supported: Yelp does not expose its not-recommended reviews. true returns 422 unsupported_parameter.
Default: false
startintegerReview offset from 0 through 10,000.
Default: 0
numintegerNumber of reviews, 1 through 49.
Default: 49
not_recommended_startintegerNot supported, because not_recommended is not supported. Any value returns 400.
timeoutnumberOptional budget for the entire request in seconds, measured from gateway receipt until the response is ready to send. Includes admission, queueing and settlement. Must be greater than 0 and at most 90. On expiry, the call is not billed and returns 503 request_deadline_exceeded with retryable=true an
Saved example response for this API; no live request is made when viewing it.
No saved response has been published. Run the API in Playground to inspect its response.