Skip to main content
GET
Query responses
See Introduction for the base URL and authentication.

Query Parameters

string
required
The ID of the review type.
string
required
The comma-separated IDs of the fields you are interested in.
string
Filter by review status. Possible values: approved, rejected.
string
Filter by response values. See Filtering Response Values for more details.
boolean
default:false
Whether to group the responses by field. If not, grouped by review.
boolean
default:false
Lists only the response values for approved reviews.
boolean
default:false
Lists only the request values for rejected reviews.
number
The number of responses to return. Maximum 500 (Team: 100, Starter: limited).

Filtering Response Values

The filterResponseValues parameter allows you to filter responses based on their field values. This parameter accepts an array of filter objects that are combined with AND logic. Filter Array (as JSON string):
The filterResponseValues parameter must be passed as a URL-encoded JSON string array.

Supported Operations

Scalar Operations:
  • == - Field equals value (example)
  • != - Field does not equal value (example)
  • > - Field > value (example)
  • >= - Field >= value (example)
  • < - Field < value (example)
  • <= - Field <= value (example)
  • contains - Field contains substring (example)
  • startsWith - Field starts with substring (example)
  • endsWith - Field ends with substring (example)
  • isTrue - Field is true (example)
  • isFalse - Field is false (example)
Array Operations:
  • arrayIncludes - Array contains value (example)
  • arrayExcludes - Array does not contain value (example)
  • arrayIsEmpty - Array is empty (example)
  • arrayIsNotEmpty - Array is not empty (example)
The filtering is done on the reviewResult.data field that you receive in review completion events to your webhooks:

Examples

Equal (==)

Not Equal (!=)

Greater Than (>)

Greater Than or Equal (>=)

Less Than (<)

Less Than or Equal (<=)

Contains

Starts With

Ends With

Is True

Is False

Array Includes

Array Excludes

Array Is Empty

Array Is Not Empty

Array Property Includes

Note: The array[].property syntax is used for filtering by/comparing with a nested property value when the array items are objects. This works like a .map() operation, allowing you to access properties within array elements.