Reviewflowz API Get an API key

Shape the review payload

A review comes light. Four parameters of GET /v3/reviews add to it, trim it, or list its earlier versions.

Run calls

Sign in to run every call on this page on your account's data. No key needed.

Parameter What you get
include=media The reviewer's photos and videos
include=reply The business's current reply
include=events The review's history: found, replied to, taken down, put back
fields=rating,text Only the fields you name
columns=all The columns of the CSV export, custom dimensions included
versions=all Every version of an edited review, not only the latest

The history of a review

include=events adds what happened to the review, oldest first.

curl "https://api.reviewflowz.com/v3/reviews?include=events&fields=rating,date,events&limit=1" \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/reviews in the reference

Example answer
{"data": [{"id": "rev_918273","rating": 5,"date": "2026-11-09T18:32:00Z","events": [{"type": "review.created","at": "2026-11-10T08:40:09Z"},{"type": "reply.drafted","at": "2026-11-10T09:05:12Z"},{"type": "reply.published","at": "2026-11-10T09:30:00Z"},{"type": "review.removed","at": "2026-11-14T06:12:44Z"},{"type": "review.reinstated","at": "2026-11-16T06:10:02Z"}]}],"next_cursor": null,"has_more": false}​
Event What happened
review.created We found the review
review.updated The reviewer edited it
review.removed The platform took it down. reason says why when the platform does: not_recommended, removed_by_platform or removed_by_reviewer
review.reinstated It's back up
reply.detected We found a reply written on the platform
reply.drafted, reply.submitted, reply.published, reply.failed What happened to the reply written in Reviewflowz

The reply

include=reply adds the business's current reply, or null when there is none.

curl "https://api.reviewflowz.com/v3/reviews?include=reply&fields=rating,text,reply&limit=1" \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/reviews in the reference

Example answer
{"data": [{"id": "rev_918273","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.","reply": {"id": "rpl_7","review": "rev_918273","origin": "reviewflowz","status": "published","text": "Thank you, Maya! We're glad the summit tickets saved you the queue. See you next time.","author": {"type": "user","name": "Sofia Martin"},"via": "reviewflowz","published_at": "2026-11-10T09:30:00Z","editable": true,"deletable": false,"created_at": "2026-11-10T09:05:12Z","updated_at": "2026-11-10T09:30:00Z"}}],"next_cursor": null,"has_more": false}​

origin says where it was written: reviewflowz, or platform for a reply written on the platform itself, which has no id. editable and deletable say what PATCH /v3/replies/rpl_7 and DELETE /v3/replies/rpl_7 can do with it.

Photos and videos

include=media adds media, with the reviewer's photos and videos, each a list of { "url": ... }.

Only the fields you need

fields keeps the top-level fields you name. id always comes, and a name that isn't a field is ignored. A part added with include must be named in fields too, as events and reply are above.

curl "https://api.reviewflowz.com/v3/reviews?fields=rating,text,date&limit=2" \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/reviews in the reference

Example answer
{"next_cursor": null,"has_more": false,"data": [{"id": "rev_918273","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.","date": "2026-11-09T18:32:00Z"}]}​

The export's columns

columns adds a columns object with the values a CSV export writes for that review. Name the columns, or send columns=all for every column your account has, custom dimensions included. With fields=id, each review is its id and those columns alone.

curl "https://api.reviewflowz.com/v3/reviews?fields=id&columns=rating,date,reply_text&limit=1" \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/reviews in the reference

Example answer
{"data": [{"id": "rev_918273","columns": {"rating": 5.0,"date": "2026-11-09T18:32:00.000Z","reply_text": "Thank you, Maya! We're glad the summit tickets saved you the queue. See you next time."}}],"next_cursor": null,"has_more": false}​

An unknown column answers 400 invalid_parameter with the list of columns you can use. Keep a warehouse or BI tool in sync uses them.

Every version of an edited review

When a reviewer edits a review, the edit is a new review with a new id. Lists hold the latest version only. versions=all lists the earlier ones too.

curl "https://api.reviewflowz.com/v3/reviews?versions=all&fields=previous_version,root_review,latest_version&limit=5" \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/reviews in the reference

Example answer
{"next_cursor": null,"has_more": false,"data": [{"id": "rev_918273","previous_version": null,"root_review": "rev_918273","latest_version": true}]}​

root_review is the first version, shared by every version of the review. previous_version is the one this version replaced, and latest_version is true on the current one.

In webhook events

A review in a webhook event already carries media and reply: nothing to ask for.