Skip to content

Client API

List published reviews from a browser

GEThttps://email.growthdept.ai/client/reviews

Sort by created, rating, updated, ascending or descending (put - in front).

Rate limits

Burst: 10/s

Steady: 150/m

Tier M. See rate limits for how requests are counted.

Authentication

The account's public key in company_id. No private key and no scopes.

Operation id

get_client_reviews The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of review resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • status: equals
  • review_type: equals
  • rating: any, equals, greater-or-equal, less-or-equal
  • id: any, equals
  • content: contains
  • smart_quote: has
  • public_reply: has
  • verified: equals
  • incentivized: equals
  • edited: equals
  • media: has
  • created: greater-or-equal, less-or-equal
  • updated: greater-or-equal, less-or-equal

string

From links.next or links.prev of the previous page.

Pagination guide

integer1 to 100default 20

Default 20, at most 100.

Pagination guide

string

Default -created.

Sorting guide

stringrequired

The account's public key.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 4 fields
    • typestringrequired

      review
    • idstringrequired

    • attributesobjectrequired

      attributes: 13 fields
      • statusone ofcan be null

        One option: ReviewStatusRejected
        • valuestringrequired

          rejected
        • rejection_reasonone ofrequired

          One option: RejectReasonOther
          • reasonstringrequired

            other
          • status_explanationstringcan be null

          One option: RejectReasonFake
          • reasonstringrequired

            fake
          One option: RejectReasonMisleading
          • reasonstringrequired

            false_or_misleading
          One option: RejectReasonPrivateInformation
          • reasonstringrequired

            private_information
          One option: RejectReasonProfanity
          • reasonstringrequired

            profanity_or_inappropriate
          One option: RejectReasonUnrelated
          • reasonstringrequired

            unrelated
        One option: ReviewStatusFeatured
        • valuestringrequired

          featured
        One option: ReviewStatusPublished
        • valuestringrequired

          published
        One option: ReviewStatusUnpublished
        • valuestringrequired

          unpublished
        One option: ReviewStatusPending
        • valuestringrequired

          pending
      • verifiedbooleanrequired

      • review_typestringrequired

        questionratingreviewstore
      • createdstring (date-time)required

      • updatedstring (date-time)required

      • imagesarray of stringsrequired

      • productobjectcan be null

        product: 4 fields
        • urlstringrequired

        • namestringrequired

        • image_urlstringcan be null

        • external_idstringcan be null

      • ratingintegercan be null

      • authorstringcan be null

      • contentstringcan be null

      • titlestringcan be null

      • smart_quotestringcan be null

      • public_replyobjectcan be null

        public_reply: 3 fields
        • contentstringrequired

        • authorstringrequired

        • updatedstring (date-time)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject