List all reviews.
GET {{baseUrl}}/v4/reviews?createdAt[gt]=2015-01-23T23:50:07Z&createdAt[gte]=2015-01-23T23:50:07Z&createdAt[lt]=2015-01-23T23:50:07Z&createdAt[lte]=2015-01-23T23:50:07Z&limit=10&cursor=MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
List of all the reviews that you have access to. The reviews are sorted by createdAt
date, with the most recent appearing first.
If the cursor
parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor
and other parameters which would change what data is being returned.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
createdAt[gt] | string | Filter on the createdAt date. | |
createdAt[gte] | string | Filter on the createdAt date. | |
createdAt[lt] | string | Filter on the createdAt date. | |
createdAt[lte] | string | Filter on the createdAt date. | |
limit | number | Max number of items to return per request. Defaults to 10 . | |
cursor | string | Retrieves the page of items that comes after the cursor . |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributions":[{"apiClientUid":"00000000-0000-0000-0000-000000000000","reviewInvitationUid":"00000000-0000-0000-0000-000000000000","userUid":"00000000-0000-0000-0000-000000000000"},{"apiClientUid":"00000000-0000-0000-0000-000000000000","reviewInvitationUid":"00000000-0000-0000-0000-000000000000","userUid":"00000000-0000-0000-0000-000000000000"}],"author":{"id":"2412341","name":"Joe Orange"},"createdAt":"2015-01-23T23:50:07Z","isRecommendation":false,"locations":[{"uid":"00000000-0000-0000-0000-000000000000"},{"uid":"00000000-0000-0000-0000-000000000000"}],"needsResponse":false,"responses":[{"body":"Thanks Joe for leaving us a review!","createdAt":"2015-01-23T23:50:07Z","siteAuthorName":"John Apple"},{"body":"Thanks Joe for leaving us a review!","createdAt":"2015-01-23T23:50:07Z","siteAuthorName":"John Apple"}],"review":{"body":"We love our new sofa from Sofa Plus! It is comfortable and stylish.","rating":5,"siteName":"Google","siteReviewId":"2390afs293fj","url":"https://www.podium.com/"},"uid":"00000000-0000-0000-0000-000000000000","updatedAt":"2015-01-23T23:50:07Z"},{"attributions":[{"apiClientUid":"00000000-0000-0000-0000-000000000000","reviewInvitationUid":"00000000-0000-0000-0000-000000000000","userUid":"00000000-0000-0000-0000-000000000000"},{"apiClientUid":"00000000-0000-0000-0000-000000000000","reviewInvitationUid":"00000000-0000-0000-0000-000000000000","userUid":"00000000-0000-0000-0000-000000000000"}],"author":{"id":"2412341","name":"Joe Orange"},"createdAt":"2015-01-23T23:50:07Z","isRecommendation":false,"locations":[{"uid":"00000000-0000-0000-0000-000000000000"},{"uid":"00000000-0000-0000-0000-000000000000"}],"needsResponse":false,"responses":[{"body":"Thanks Joe for leaving us a review!","createdAt":"2015-01-23T23:50:07Z","siteAuthorName":"John Apple"},{"body":"Thanks Joe for leaving us a review!","createdAt":"2015-01-23T23:50:07Z","siteAuthorName":"John Apple"}],"review":{"body":"We love our new sofa from Sofa Plus! It is comfortable and stylish.","rating":5,"siteName":"Google","siteReviewId":"2390afs293fj","url":"https://www.podium.com/"},"uid":"00000000-0000-0000-0000-000000000000","updatedAt":"2015-01-23T23:50:07Z"}],"metadata":{"nextCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","previousCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","totalItems":-61664327,"url":"https://www.podium.com/"}}