Skip to main content
GET
/
v1
/
reviews
List Reviews
curl --request GET \
  --url https://api.withflex.com/v1/reviews \
  --header 'Authorization: Bearer <token>'
{
  "reviews": [
    {
      "review_id": "obj_01EXAMPLE00000000000000000",
      "stripe_review_id": "obj_01EXAMPLE00000000000000000",
      "charge_id": "obj_01EXAMPLE00000000000000000",
      "payment_intent_id": "obj_01EXAMPLE00000000000000000",
      "partner_id": "obj_01EXAMPLE00000000000000000",
      "reason": "rule",
      "opened_reason": "rule",
      "closed_reason": "approved",
      "open": false,
      "billing_zip": "string",
      "ip_address": "string",
      "test_mode": false,
      "client_reference_id": "obj_01EXAMPLE00000000000000000",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.withflex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
open
boolean | null

Filter by review state. true returns only open reviews, false returns only closed. Omit to return both.

​
charge_id
string | null

Filter to reviews on a specific charge.

Example:

"obj_01EXAMPLE00000000000000000"

​
payment_intent_id
string | null

Filter to reviews on a specific payment intent.

Example:

"obj_01EXAMPLE00000000000000000"

​
client_reference_id
string | null

Filter by client_reference_id (matches the partner-supplied identifier on the underlying checkout session, when present).

​
starting_after
string | null

Cursor for forward pagination — review id from a previous page.

Example:

"obj_01EXAMPLE00000000000000000"

​
ending_before
string | null

Cursor for backward pagination.

Example:

"obj_01EXAMPLE00000000000000000"

​
limit
integer<int32> | null

Page size, between 1 and 100. Default 20.

Required range: 1 <= x <= 100
Example:

10

Response

Success

​
reviews
object[]
required