Get Reviews
GET {{baseUrl}}/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](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.
Get all reviews.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
reviews:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[event] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sparse-fieldsets | |
fields[review] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>created: greater-or-equal, less-or-equal<br>rating: any, equals, greater-or-equal, less-or-equal<br>id: any, equals<br>item.id: any, equals<br>content: contains<br>status: equals<br>review_type: equals<br>verified: equals | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#pagination | |
page[size] | number | 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
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"review","id":"\u003cstring\u003e","attributes":{"email":"\u003cstring\u003e","verified":"\u003cboolean\u003e","review_type":"question","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"product":{"url":"\u003cstring\u003e","name":"\u003cstring\u003e","image_url":"\u003cstring\u003e"},"status":"featured","rating":"\u003cinteger\u003e","author":"\u003cstring\u003e","content":"\u003cstring\u003e","title":"\u003cstring\u003e","smart_quote":"\u003cstring\u003e","public_reply":{"content":"\u003cstring\u003e","author":"\u003cstring\u003e","updated":"\u003cdateTime\u003e"}},"links":{"self":"\u003curi\u003e"},"relationships":{"events":{"data":[{"type":"event","id":"\u003cstring\u003e"},{"type":"event","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"item":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"review","id":"\u003cstring\u003e","attributes":{"email":"\u003cstring\u003e","verified":"\u003cboolean\u003e","review_type":"question","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"product":{"url":"\u003cstring\u003e","name":"\u003cstring\u003e","image_url":"\u003cstring\u003e"},"status":"published","rating":"\u003cinteger\u003e","author":"\u003cstring\u003e","content":"\u003cstring\u003e","title":"\u003cstring\u003e","smart_quote":"\u003cstring\u003e","public_reply":{"content":"\u003cstring\u003e","author":"\u003cstring\u003e","updated":"\u003cdateTime\u003e"}},"links":{"self":"\u003curi\u003e"},"relationships":{"events":{"data":[{"type":"event","id":"\u003cstring\u003e"},{"type":"event","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"item":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"event","id":"\u003cstring\u003e","attributes":{"timestamp":"\u003cinteger\u003e","event_properties":{},"datetime":"\u003cdateTime\u003e","uuid":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"event","id":"\u003cstring\u003e","attributes":{"timestamp":"\u003cinteger\u003e","event_properties":{},"datetime":"\u003cdateTime\u003e","uuid":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}}]}