Reviewflowz API Get an API key

Errors and limits

What a failed call answers, how to page through lists, the rate limit, safe retries and versions.

Errors

Errors use RFC 9457 problem details. Branch on code, and quote request_id if you contact us.

{"type": "https://api.reviewflowz.com/v3/errors#invalid_parameter","title": "Bad Request","status": 400,"code": "invalid_parameter","detail": "limit: Use a whole number from 1 to 500.","request_id": "8c1f4e2a-93b7-4d0e-a6f5-2b9d7c3e1a40","errors": [{ "field": "limit", "code": "invalid", "detail": "Use a whole number from 1 to 500." }]}​

Pagination

Lists return data, next_cursor and has_more. Pass next_cursor back as cursor to get the next page. limit goes up to 500.

curl "https://api.reviewflowz.com/v3/reviews?limit=500&cursor=eyJpZCI6OTE4MjczfQ" \-H "Authorization: Bearer rfz_live_..."​

Rate limit

300 requests a minute per account. Past it you get 429 with Retry-After, the seconds to wait.

Safe retries

Send Idempotency-Key on a POST. Retrying with the same key within 24 hours returns the first answer instead of running again.

curl https://api.reviewflowz.com/v3/sources \-H "Authorization: Bearer rfz_live_..." \-H "Idempotency-Key: 6f1c2b7e-batch-1" \-H "Content-Type: application/json" \-d '{"urls": ["https://maps.app.goo.gl/Gjo5NDggCfPg8EWL8"]}'​

Versions

Send Reviewflowz-Version: 2026-10-29 to pin one. Every answer says which version replied.

Error codes

The code of an error answer.

Code Status What to do
unauthorized 401 The key is missing, wrong or revoked. Send Authorization: Bearer <key>.
insufficient_scope 403 The key has no permission for this call. Give it the permission, or use another key.
forbidden 403 The member the key acts as can't do this. Use a key created by an admin.
plan_restricted 403 The feature isn't in the account's plan. Upgrade from Billing in the app.
not_found 404 Nothing with that id exists in this account.
route_not_found 404 No such endpoint. The full list is at /v3/openapi.json.
invalid_json 400 The request body isn't valid JSON.
parameter_missing 400 A required parameter is missing. errors names it.
invalid_parameter 400 A parameter has a value we can't use. errors names it and says what's allowed.
validation_failed 422 Nothing was saved. errors lists each field and what to fix.
unsupported_version 400 The Reviewflowz-Version you sent doesn't exist. The answer lists the ones that do.
invalid_idempotency_key 400 The Idempotency-Key is too long. A UUID works well.
idempotency_key_in_use 409 A request with this Idempotency-Key is still running. Retry in a few seconds for its result.
idempotency_key_reused 422 This Idempotency-Key was already used for a different request. Use a new key for each new request.
rate_limited 429 More than 300 requests in a minute. Wait Retry-After seconds.
quota_exceeded 429 The account used its daily allowance of this call. GET /v3/usage shows what's left.
source_limit_reached 403 The account can't add more sources right now. The same code is a reason on a rejected URL when other URLs in the call were added.
source_paused 409 The source is paused in the app. Resume it there to check it.
sync_too_soon 429 The source was checked less than one cycle ago. Nothing was checked; Retry-After says in how many seconds to call again.
not_repliable 409 We can't post replies to that platform for this source. Save a draft with publish: false and post it on the platform.
confirmation_required 409 Some of these contacts would get a review request, and nobody was added. sends lists them with their timing. Send the same call with "confirm": true to add them and send.
campaign_incomplete 409 The campaign isn't ready to turn on. blockers says what to finish in the app.
credits_required 402 The account has no credits for this channel. Buy credits in the app, or turn on auto-recharge, then call again.
payment_action_required 402 The card must confirm the credit purchase. Open hosted_invoice_url, then call again.
sms_setup_required 409 Text messages aren't set up yet. Finish it in the app (Settings > Request sending), then call again.
under_review 409 Sending is under review for this account. We email you when it's cleared.
reply_published 409 The review already has a published reply. Edit it with PATCH /v3/replies/{id}.
reply_too_long 422 The reply is longer than the platform allows. Shorten it to the length detail gives.
generation_failed 422 The reply agent couldn't write a reply. Retry once; a review with no text may have nothing to answer.
publish_failed 502 The platform didn't take the reply. detail says why and what to do, like reconnecting the account in the app.
trial_reply_limit 403 The free trial has posted all its replies. Subscribe in the app to keep replying.
not_forecastable 422 Forecasts work on Google Maps and Tripadvisor sources. Pick a source on one of them.
no_reviews 422 The business has no reviews yet, so there's no rating to forecast from.
internal_error 500 Something broke on our side. It's reported; quote request_id if you contact us.

Why a URL was rejected

The reason of a URL in rejected, when the call itself succeeded.

Code Status What to do
unsupported_url rejected Not a review page on a platform we support.
already_added rejected Already a source in this account; its id comes with the rejection.
not_a_review_page rejected The platform has no listing at that URL. Copy it from the listing itself.
platform_timeout rejected The platform took too long to answer. Try that URL again in a minute.
platform_unreachable rejected We couldn't reach the platform just now. Try that URL again in a minute.
location_required rejected On an account billed per location, send location with an id from GET /v3/locations.
on_another_account rejected That page is already tracked by another account on a trial.
invalid rejected The source couldn't be saved; detail says why.