How to fetch product reviews using Flowbox's API

This guide will walk you through the process of retrieving your company data using Flowbox's API.

Prerequisites

Before you start, ensure you have the following:

API key: Your unique API authentication key. If you don't have it yet, please contact your CSM and they'll provide it to you.
Company ID: Your company's unique ID, your CSM can provide it for you.

API Endpoint

To retrieve the list of flows in your Flowbox account, you need to send a GET request to the following endpoint:

https://external-api.getflowbox.com/v2/reviews/company/{companyId}

You can find more information and make test calls in our Swaggerhub page.

Required Parameters

Parameter	Type	Location	Description
`api-key`	string	header	Your API authentication key. Must be included in every request.
`companyId`	string	path	The company ID to return data from.

Optional Parameters

Parameter	Type	Location	Description
`product_identifier`	string	header	Product identifier to filter reviews, must match identifier in tour catalog.
`status`	string	path	Filter reviews by status.
`after`	string	query	ISO datetime string to filter reviews created after this time, e.g. `"2026-01-01T00:00:00.000000+0000"`.
`first`	integer	query	Number of reviews to return.
`locale`	string	query	Comma separated list of locales to filter reviews, e.g. `"en-US,fr-FR"`.
`product_locale`	string	query	Locale to retrieve product data.

Example API Request

Here is an example request with both required and optional parameters:

curl -X 'GET' \  
'https://external-api.getflowbox.com/v2/reviews/company/INSERT_COMPANY_ID_HERE?first=5' \   
-H 'accept: application/json' \   
-H 'api-key: INSERT_API_KEY_HERE'

Response:

The response will be a JSON containing the reviews for the company provided, filtered by the queries provided.

JSON returned:

Root:

Field	Type	Description
`status`	string	Request status. One of: `"success"`, `"error"`.
`data.totalCount`	integer	Total number of reviews matching the query.
`data.reviews`	array	List of review objects. See Review object table below.
`data.has_next_page`	boolean	Whether there is a next page of results.
`data.has_previous_page`	boolean	Whether there is a previous page of results.
`data.start_cursor`	string	Cursor timestamp of the first item on the current page. Use for backward pagination.
`data.end_cursor`	string	Cursor timestamp of the last item on the current page. Use for forward pagination.

Review (object):

Field	Type	Description
`id`	string	Unique identifier for the review. UUID format.
`product`	object	Product the review is associated with. See Product table below.
`title`	string	Title of the review.
`description`	string	Body text of the review.
`stars`	float	Star rating given by the reviewer, e.g. `4.0`, `5.0`.
`consumer`	object	Information about the reviewer. See Consumer table below.
`status`	string	Moderation status of the review, e.g. `"published"`.
`language`	string	ISO 639-1 language code of the review, e.g. `"en"`.
`createdAt`	string	ISO 8601 timestamp of when the review was submitted.
`updatedAt`	string	ISO 8601 timestamp of when the review was last updated.
`reply`	string	Merchant reply to the review. `null` if no reply has been submitted.

Product (object):

Field	Type	Description
`id`	string	Product key in Flowbox. Format: `"{companyId}_{identifier}_{catalogId}"`.
`identifier`	string	Product identifier as provided in the product feed.
`companyId`	integer	Flowbox company ID.
`name`	string	Display name of the product.
`url`	string	URL to the product's page.
`image_url`	string	URL to the product's main image. `null` if not available.
`category`	string	Category path of the product, in breadcrumb-style format, e.g. `"Men > Clothing > Shoes"`.
`description`	string	Product description as provided in the feed.
`source`	string	Feed source the product was imported from, e.g. `"Google"`.

Consumer (object):

Field	Type	Description
`displayName`	string	Display name of the reviewer.
`verified`	boolean	Whether the reviewer's identity has been verified.
`buyer`	boolean	Whether the reviewer is a confirmed buyer of the product.