Get Reviews

get https://a.klaviyo.com/api/reviews/

🚧
This endpoint is in beta and subject to change.
A beta revision header (2024-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Get all reviews.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
reviews:read

Query Params

fields[event]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sparse-fieldsets

fields[event]

fields[review]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sparse-fieldsets

fields[review]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#filtering
Allowed field(s)/operator(s):
created: greater-or-equal, less-or-equal
rating: any, equals, greater-or-equal, less-or-equal
id: any, equals
item.id: any, equals
content: contains
status: equals
review_type: equals
verified: equals

include

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#relationships

include

page[cursor]

string

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#pagination

page[size]

integer

1 to 100

Defaults to 20

Default: 20. Min: 1. Max: 100.

sort

string

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sorting

Headers

revision

string

required

Defaults to 2024-07-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://a.klaviyo.com/api/reviews/?page[size]=20' \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'revision: 2024-07-15.pre'


xxxxxxxxxx
80
}
1
{
2
  "data": [
3
    {
4
      "type": "review",
5
      "id": "925e385b52fb405715f3616c337cc65c",
6
      "attributes": {
7
        "email": "john@doe.com",
8
        "status": "featured",
9
        "verified": true,
10
        "review_type": "review",
11
        "created": "2022-11-08T00:00:00+00:00",
12
        "updated": "2022-11-08T00:00:00+00:00",
13
        "images": [
14
          "https://example.com/image1.jpg",
15
          "https://example.com/image2.jpg"
16
        ],
17
        "product": {
18
          "url": "https://example.com/product/123",
19
          "name": "string",
20
          "image_url": "https://example.com/image.jpg"
21
        },
22
        "rating": 2,
23
        "author": "John D",
24
        "content": "Great product! I love the smell. I will be buying again.",
25
        "title": "Smells great, would recommend",

200Success

4XXClient Error

5XXServer Error