Before you start
- A key with
sources:write,reviews:readandwebhooks:write. To try the reading steps first, a Read only key changes nothing. - The API is part of the Premium plan (see pricing). API-only plans start at $300 a month: book a 30-minute call for a custom quote.
The example follows one business, the Eiffel Tower in Paris.
1. Find the pages
Send the business's name, address, phone or website as q, up to 5 platforms as platform, and the country to search in (US when you leave it out).
curl "https://api.reviewflowz.com/v3/lookup?q=Tour%20Eiffel%20Paris&platform=google_maps,tripadvisor&country=FR" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/lookup?q=Tour%20Eiffel%20Paris&platform=google_maps,tripadvisor&country=FR", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/lookup",headers={"Authorization": "Bearer rfz_live_...",},params={"q": "Tour Eiffel Paris", "platform": "google_maps,tripadvisor", "country": "FR"},)print(res.json())
Edit the request
GET /v3/lookup in the reference
Example answer
Candidates come back best match first, each with a match_score. A platform that didn't answer within 25 seconds is named in incomplete: ask again for it. Nothing is added to your account yet. Keep the url of each candidate that is the business.
56 of the 61 supported platforms can be looked up by name. On Trusted, Whop, Skillshare and Zocdoc, open the business's page and copy its URL from the browser for step 2. Facebook pages are connected in the app instead.
2. Add them
Send up to 10 URLs per call. Prefer: wait=25 waits up to 25 seconds for their first import.
curl https://api.reviewflowz.com/v3/sources \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-H "Idempotency-Key: eiffel-tower-1" \-H "Prefer: wait=25" \-d '{"urls": ["https://maps.app.goo.gl/Gjo5NDggCfPg8EWL8"]}'
const res = await fetch("https://api.reviewflowz.com/v3/sources", {method: "POST",headers: {"Authorization": "Bearer rfz_live_...","Content-Type": "application/json","Idempotency-Key": "eiffel-tower-1","Prefer": "wait=25",},body: JSON.stringify({"urls": ["https://maps.app.goo.gl/Gjo5NDggCfPg8EWL8"]}),});console.log(await res.json());
import requestsres = requests.post("https://api.reviewflowz.com/v3/sources",headers={"Authorization": "Bearer rfz_live_...","Content-Type": "application/json","Idempotency-Key": "eiffel-tower-1","Prefer": "wait=25",},json={"urls": ["https://maps.app.goo.gl/Gjo5NDggCfPg8EWL8"]},)print(res.json())
Edit the request
POST /v3/sources in the reference
Example answer
200 means the import finished, and each source also carries the first page of its reviews in reviews. 202 means it's still importing: GET /v3/sources?status=syncing lists the sources not done yet. The Idempotency-Key makes a retry of the same call safe (safe retries). Keep each source's id (src_4812 here): the next steps use it.
A URL that can't be added comes back in rejected with a reason:
unsupported_url: not a review page on a platform we support.already_added: already a source, whoseidcomes with it.not_a_review_page: the platform has no listing at that URL. Copy it from the listing itself.platform_timeoutorplatform_unreachable: try that URL again in a minute.source_limit_reached: the account can't add more sources right now (below).location_required: on an account billed per location, sendlocationwith an id fromGET /v3/locations.
What adding costs. On a plan billed per source, a source added past the number you pay for upgrades the plan at once. GET /v3/usage shows what you pay for (paid_units), what's in use (active_units), the price of the next one (next_units) and how many sources this billing period still allows (creation_limit). Where the plan doesn't upgrade by itself, a call past the limit answers 403 source_limit_reached and adds nothing.
3. Read the history
Page through the source's reviews, up to 500 a call, newest found first. Pass next_cursor back as cursor until has_more is false.
curl "https://api.reviewflowz.com/v3/reviews?source=src_4812&limit=500" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?source=src_4812&limit=500", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"source": "src_4812", "limit": "500"},)print(res.json())
Edit the request
- platform · Comma-separated platform ids.
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- date_after · Posted on the platform at or after.
- updated_after · Catch up after downtime: reviews found, edited, removed,...
- cursor · The next_cursor from the previous page. Leave it out for the first...
- id · Comma-separated review ids: id=rev_1 reads one review.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_before
- created_after · Found by Reviewflowz at or after.
- created_before
- source_created_after · Reviews of sources added at or after (bulk imports).
- tag · Comma-separated tag ids.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply
- removed
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- q · Full-text search (title, text, pros, cons, reviewer); every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- versions · latest lists only the current version of an edited review; all...
- include · Any of media, reply, events, comma-separated.
- fields · Only these top-level fields (id always comes).
- columns · Comma-separated export columns (rating, date, reviewer,...
- sort · created: newest found first. date: newest posted on the platform...
GET /v3/reviews in the reference
Example answer
Shortened: each review also has title, pros, cons, language, tags, topics, owners and its edit history fields. How far back a first import goes depends on the platform: its page says, like Google Maps.
4. Hear about new ones
Subscribe a URL of yours to the review events, and to rating.changed for step 6.
curl https://api.reviewflowz.com/v3/webhook-endpoints \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-d '{"url": "https://hooks.yourcompany.com/reviewflowz","events": ["review.created", "review.updated", "review.removed", "review.reinstated", "rating.changed"]}'
const res = await fetch("https://api.reviewflowz.com/v3/webhook-endpoints", {method: "POST",headers: {"Authorization": "Bearer rfz_live_...","Content-Type": "application/json",},body: JSON.stringify({"url": "https://hooks.yourcompany.com/reviewflowz", "events": ["review.created", "review.updated", "review.removed", "review.reinstated", "rating.changed"]}),});console.log(await res.json());
import requestsres = requests.post("https://api.reviewflowz.com/v3/webhook-endpoints",headers={"Authorization": "Bearer rfz_live_...","Content-Type": "application/json",},json={"url": "https://hooks.yourcompany.com/reviewflowz", "events": ["review.created", "review.updated", "review.removed", "review.reinstated", "rating.changed"]},)print(res.json())
Edit the request
POST /v3/webhook-endpoints in the reference
Example answer
Keep the secret (whsec_...): it signs every event, and no other API answer shows it again. Account admins can see it in the app.
Each new review then arrives as a POST like this one (review.created):
{"id": "evt_4821","type": "review.created","timestamp": "2026-11-10T08:40:09Z","data": {"object": {"id": "rev_918273","source": "src_4812","platform": "google_maps","rating": 5,"text": "Booked the summit tickets online and skipped the whole queue. The view at sunset was worth every euro, and the staff on the second floor were patient with our kids.","reviewer": {"name": "Maya Chen","company": null,"avatar_url": null},"date": "2026-11-09T18:32:00Z"},"source": "src_4812"}}
A source's first import sends no review.created: that history is what you read in step 3. Every review found after it sends one.
review.updated: the reviewer edited the review. The event carries the new version; itsprevious_versionis the one it replaced.review.removed: the platform took the review down or hid it as not recommended. The review stays, withremoved: trueandremoved_at.review.reinstated: a removed review is back.
Check each event's signature and answer quickly: Webhooks shows how, and what happens when your server is down.
5. Or ask what changed
No server to receive events, or back after downtime? Ask for everything that changed since your last check:
curl "https://api.reviewflowz.com/v3/reviews?updated_after=2026-11-01T00%3A00%3A00Z&limit=500" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?updated_after=2026-11-01T00%3A00%3A00Z&limit=500", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"updated_after": "2026-11-01T00:00:00Z", "limit": "500"},)print(res.json())
Edit the request
- source · Comma-separated source ids.
- platform · Comma-separated platform ids.
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- date_after · Posted on the platform at or after.
- cursor · The next_cursor from the previous page. Leave it out for the first...
- id · Comma-separated review ids: id=rev_1 reads one review.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_before
- created_after · Found by Reviewflowz at or after.
- created_before
- source_created_after · Reviews of sources added at or after (bulk imports).
- tag · Comma-separated tag ids.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply
- removed
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- q · Full-text search (title, text, pros, cons, reviewer); every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- versions · latest lists only the current version of an edited review; all...
- include · Any of media, reply, events, comma-separated.
- fields · Only these top-level fields (id always comes).
- columns · Comma-separated export columns (rating, date, reviewer,...
- sort · created: newest found first. date: newest posted on the platform...
The answer has the reviews found, edited, removed, reinstated, replied to, tagged or given an owner since that time, in the shape of step 3. Note when you asked, and send that time next.
6. Follow the rating
GET /v3/ratings gives each source's rating and review count today, and how they moved over 7 and 30 days.
curl "https://api.reviewflowz.com/v3/ratings?source=src_4812" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/ratings?source=src_4812", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/ratings",headers={"Authorization": "Bearer rfz_live_...",},params={"source": "src_4812"},)print(res.json())
Edit the request
- limit · Rows per page (default 50).
- cursor · The next_cursor from the previous page. Leave it out for the first...
- country · worldwide, all, or ISO codes: US,DE.
- platform
- location
- dimension[key]
- sort · score, count, new_ratings_7d, new_ratings_30d, score_change_7d,...
GET /v3/ratings in the reference
Example answer
Each source has one worldwide row. On the app stores, which rate per country, add country=all or country=US,FR for a row per country. rating.changed, subscribed in step 4, tells you when a rating or review count changes, with the previous values. GET /v3/ratings/history has the series over time.
Need them right now?
A source checks for new reviews on its own. To check one now:
curl -X POST https://api.reviewflowz.com/v3/sources/src_4812/sync \-H "Authorization: Bearer rfz_live_..." \-H "Prefer: wait=25"
const res = await fetch("https://api.reviewflowz.com/v3/sources/src_4812/sync", {method: "POST",headers: {"Authorization": "Bearer rfz_live_...","Prefer": "wait=25",},});console.log(await res.json());
import requestsres = requests.post("https://api.reviewflowz.com/v3/sources/src_4812/sync",headers={"Authorization": "Bearer rfz_live_...","Prefer": "wait=25",},)print(res.json())
Edit the request
200 means the check finished, and reviews holds the reviews it found. 202 means it's still running: read GET /v3/sources/src_4812 later. A call too soon after the source's last check answers 429 sync_too_soon with a Retry-After header, and checks nothing. Its last_synced_at says when it was last checked. A source paused in the app answers 409 source_paused.
What it costs and where it stops
- On a plan billed per source, each source past the paid number upgrades the plan at once (step 2).
- 5 platforms per lookup, 10 URLs per
POST /v3/sources, 500 reviews per page. Rate limits. - A first import sends no
review.created. - Removed reviews stay in
GET /v3/reviewswithremoved: true. Addremoved=falseto leave them out.
When something else fits better
To get new reviews in Slack, Microsoft Teams or by email, you need no code: set up an alert in the app, under Integrations → Forward Reviews. POST /v3/alerts creates one too, sent to a channel already connected there (GET /v3/alerts/destinations lists them).