Quick Start
Get Your Credentials
Your API requests are authenticated using your Okendo User ID and an API Key. You can get these details from the integration settings section of the Okendo app.
Make Your First Request
To make your first request, send an authenticated request to the /reviews
endpoint. This will fetch some of your published reviews
.
Returns a list of Reviews for the requested store
Authorizations
Query parameters
limitinteger · int32OptionalExample:
A limit on the number of items returned. Between 1 and 100. Default 25.
25
lastEvaluatedstringOptional
The URL-encoded JSON object representing the cursor for the next page of results.
orderBystringOptionalExample:
The sort order of the reviews. Format: '(date|rating) (asc|desc)'. Default 'date desc'
date desc
statusstring · enumOptionalExample:
The moderation status of the review.
approved
Possible values: Responses
200
An object containing a list of Reviews and a relative link to the next page of results if available.
application/json
400
Invalid request parameters.
application/json
401
Authentication credentials are missing or incorrect.
get
GET /enterprise/reviews HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*
{
"reviews": [
{
"subscriberId": "123e4567-e89b-12d3-a456-426614174000",
"reviewId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "shopify-123456789",
"attributesWithRating": [
{
"minLabel": "Too Small",
"midLabel": "Just Right",
"maxLabel": "Too Big",
"title": "Sizing",
"type": "centered-range",
"value": 1
}
],
"body": "Great quality! Great price! Would buy again!",
"containsProfanity": true,
"dateCreated": "2025-06-26T13:24:34.170Z",
"helpfulCount": 1,
"isRecommended": true,
"media": [
{
"streamId": "123e4567-e89b-12d3-a456-426614174000",
"fullSizeUrl": "https://example.com",
"largeUrl": "https://example.com",
"thumbnailUrl": "https://example.com",
"type": "image",
"isHidden": true
}
],
"productAttributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"productName": "MacBook Pro",
"order": {
"orderId": "123456789",
"orderNumber": "#OKRXXXX"
},
"rating": 5,
"reply": {
"body": "<p><b>Thanks</b> for your review</p>",
"dateCreated": "2025-06-26T13:24:34.170Z",
"rawBody": "*Thanks* for your review",
"isPrivate": true
},
"reviewer": {
"attributes": [
{
"title": "Pros",
"type": "drop-down",
"value": "Powerful"
}
],
"avatarUrl": "https://example.com",
"displayName": "Tim C.",
"email": "[email protected]",
"isVerified": true,
"location": {
"country": {
"code": "au",
"name": "Australia"
},
"zoneCode": "NSW"
},
"name": "Tim Cook",
"socialConnection": "facebook",
"verifiedStatus": "Verified Buyer"
},
"reward": {
"description": "$10 off your next order over $40",
"integration": "loyaltyLion",
"type": "coupon",
"value": "OKRX-XXXXX-XXXX",
"isCouponUpgrade": true
},
"sentiment": "positive",
"status": "approved",
"tags": [
"Support Needed",
"Favourite"
],
"title": "Love these shoes!",
"unhelpfulCount": 1,
"variantId": "1234567890",
"variantName": "MacBook Pro - 15 Inch"
}
],
"nextUrl": "https://example.com"
}
To make the request, use a networking client of your choice or follow these examples:
curl https://api.okendo.io/enterprise/reviews -u <okendo_user_id>:<api_key>
Last updated