{"info":{"_postman_id":"bfdfef80-5781-b553-5481-5b4c363f6102","name":"Reviewshake API (public)","description":"

Welcome to the Reviewshake API documentation, where you will find all details required to interact with our API.

In order to make calls, you will need two pieces of information:

Your Reviewshake subdomain (eg. demo.reviewshake.com)
Your API key, see the Authentication section below.

Authentication

Your account will have a unique API key associated with it, which can be found under Configurations -> General Settings in your dashboard.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"2364352","collectionId":"bfdfef80-5781-b553-5481-5b4c363f6102","publishedId":"7TNfBHp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-04-04T02:48:58.000Z"},"item":[{"name":"Clients","item":[{"name":"Create client","id":"433e7483-4791-4c35-8c5b-983e052593bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","value":"API_KEY","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Client name\",\n \"slug\": \"Client short name\",\n \"locale\": \"en\"\n}"},"url":"https://subdomain.reviewshake.com/api/v1/clients","urlObject":{"protocol":"https","path":["api","v1","clients"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"433e7483-4791-4c35-8c5b-983e052593bf"},{"name":"Get client","id":"f9531280-9f7c-497b-8af8-b4aeeac61551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/clients/1","urlObject":{"protocol":"https","path":["api","v1","clients","1"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9531280-9f7c-497b-8af8-b4aeeac61551"},{"name":"Get clients","id":"243edc8c-e3b8-423f-af10-c8c667d02c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/clients","description":"

Available parameters:

page, Optional
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=1
per_page, Optional
The number of reviews to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?per_page=3

\n","urlObject":{"protocol":"https","path":["api","v1","clients"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"243edc8c-e3b8-423f-af10-c8c667d02c40"},{"name":"Get client locations","id":"24d89ef2-428c-48aa-a464-cb6cdc8d5c65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/clients/1/locations","urlObject":{"protocol":"https","path":["api","v1","clients","1","locations"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"24d89ef2-428c-48aa-a464-cb6cdc8d5c65"}],"id":"d05a4b95-ee02-466f-8368-a6b6c7a776aa","_postman_id":"d05a4b95-ee02-466f-8368-a6b6c7a776aa","description":""},{"name":"Customers","item":[{"name":"Subscribe to campaign","id":"d051fda6-8f95-4244-a737-f358ee4bb886","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","value":"API_KEY","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"campaign_name\": \"order created\",\n \"customer\": {\n \"first_name\": \"aaa\",\n \"last_name\": \"bbb\",\n \"email\": \"aaa@gmail.com\",\n \"phone\": \"+12323232\",\n \"client\": \"aaa\",\n \"location_slug\": \"location-name\"\n }\n}"},"url":"https://subdomain.reviewshake.com/api/v1/customer/subscribe","urlObject":{"protocol":"https","path":["api","v1","customer","subscribe"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d051fda6-8f95-4244-a737-f358ee4bb886"},{"name":"Unsubscribe customer","id":"2c37d374-b70d-4535-8486-c00b5e18eaf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"first_name\": \"aaa\",\n \"last_name\": \"bbb\",\n \"email\": \"aaa@gmail.com\",\n \"phone\": \"+12323232\",\n \"client\": \"aaa\"\n }\n}"},"url":"https://subdomain.reviewshake.com/api/v1/customer/unsubscribe","urlObject":{"protocol":"https","path":["api","v1","customer","unsubscribe"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c37d374-b70d-4535-8486-c00b5e18eaf5"}],"id":"ee57f1f8-1cca-4a32-b9ec-0e2b87830d6c","_postman_id":"ee57f1f8-1cca-4a32-b9ec-0e2b87830d6c","description":""},{"name":"Invitations","item":[{"name":"Get invitations","id":"b0da1392-012e-4486-8484-9900415e2a24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"client_slug\": \"client-1\"\n}"},"url":"https://subdomain.reviewshake.com/api/v1/invitations","description":"

Available parameters:

page, Optional
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=1
per_page, Optional
The number of reviews to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?per_page=3

\n","urlObject":{"protocol":"https","path":["api","v1","invitations"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0da1392-012e-4486-8484-9900415e2a24"}],"id":"fb9322fb-9dd2-4805-8842-a75564a6b8eb","_postman_id":"fb9322fb-9dd2-4805-8842-a75564a6b8eb","description":""},{"name":"Landing page","item":[{"name":"Update reviews landing page","id":"0af25d3f-0218-46f4-8588-cc73b6081ee1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"funnel_type\": \"stars\",\n \"landing_text\": \"Landing text\",\n \"landing_logo\": \"https://avatars0.githubusercontent.com/xxxx\"\n}"},"url":"https://subdomain.reviewshake.com/api/v1/landing_page/reviews","description":"

Available funnel_type: stars, thumbs, faces, buttons, locations

\n","urlObject":{"protocol":"https","path":["api","v1","landing_page","reviews"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0af25d3f-0218-46f4-8588-cc73b6081ee1"}],"id":"47074807-af5f-4a68-90ea-b8d081df6da9","_postman_id":"47074807-af5f-4a68-90ea-b8d081df6da9","description":""},{"name":"Locations","item":[{"name":"Create location","id":"acb3491a-90be-4b4f-9853-954d1c651e51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Location name\",\n \"slug\": \"Location short name\",\n \"client\": \"Client name\"\n}"},"url":"https://subdomain.reviewshake.com/api/v1/locations","urlObject":{"protocol":"https","path":["api","v1","locations"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"acb3491a-90be-4b4f-9853-954d1c651e51"},{"name":"Get locations","id":"72051eed-66fb-491d-a2fe-c1c78c3103a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/locations","urlObject":{"protocol":"https","path":["api","v1","locations"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"72051eed-66fb-491d-a2fe-c1c78c3103a1"}],"id":"36d028a5-3e0d-4d62-a165-21e74e922ae8","_postman_id":"36d028a5-3e0d-4d62-a165-21e74e922ae8","description":""},{"name":"Reviews","item":[{"name":"List reviews","id":"cae618f1-ceda-4bd7-8d9e-56389a1627f3","request":{"method":"GET","header":[{"key":"X-Spree-Token","value":"API_KEY"},{"key":"Content-Type","value":"application/json"}],"url":"https://subdomain.reviewshake.com/api/v1/reviews","description":"

Available parameters:

rating, Optional
Filter reviews by a given rating.
Constraints: The allowed range is minimum: 1, maximum: 5
Example: ?rating=5
page, Optional
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=1
perPage, Optional
The number of reviews to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?perPage=3
client, Optional
Filter reviews by a given client
Example: ?client=client
client_slug, Optional
Filter reviews by a given client slug
Example: ?client_slug=client-name
location, Optional
Filter reviews by a given location
Example: ?location=location_name
startDate, Optional
Filter reviews with greater equal than startDate
Example: ?startDate=2018-01-01
endDate, Optional
Filter reviews with less equal than endDate
Example: ?startDate=2018-12-31
sourceName, Optional
Fitler reviews by a given review source
Example: ?sourceName=Facebook
org, Optional
Fitler reviews from a given organization
Example: ?org=3

\n","urlObject":{"protocol":"https","path":["api","v1","reviews"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cae618f1-ceda-4bd7-8d9e-56389a1627f3"},{"name":"Create manual review","id":"3cd2e46f-5f15-49a5-8bac-270d73b5d1bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"rating\": 5,\n \"review_date\": \"2019-02-18\",\n \"review\": \"This is good service\",\n \"name\": \"Reviewer name\",\n \"profile_image_url\": \"https://avatar.com/xxx\",\n \"source_id\": 1,\n \"source\": \"My Custom Source\",\n \"client\": \"Client name\",\n \"location\": \"Location name\"\n}"},"url":"https://subdomain.reviewshake.com/api/v1/reviews/add","urlObject":{"protocol":"https","path":["api","v1","reviews","add"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cd2e46f-5f15-49a5-8bac-270d73b5d1bc"}],"id":"f68224f7-32e2-4df3-8e4b-175603cf8b92","_postman_id":"f68224f7-32e2-4df3-8e4b-175603cf8b92","description":""},{"name":"Review source","item":[{"name":"Create review source","id":"bb32a639-c6a3-408d-8065-0e68d92010c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"source\": \"yelp\",\n \"url\": \"https://www.yelp.com/biz/naturally-delicious-brooklyn\",\n \"client\": \"Client name\",\n \"location\": \"Location name\"\n}"},"url":"https://subdomain.reviewshake.com/api/v1/review_sources/add","urlObject":{"protocol":"https","path":["api","v1","review_sources","add"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb32a639-c6a3-408d-8065-0e68d92010c2"},{"name":"Delete review source(s)","id":"7bfbd470-a972-471e-a7a3-769105ccc7b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://subdomain.reviewshake.com/api/v1/bulk_review_sources?source_ids[]=1&source_ids[]=2","urlObject":{"protocol":"https","path":["api","v1","bulk_review_sources"],"host":["subdomain","reviewshake","com"],"query":[{"key":"source_ids[]","value":"1"},{"key":"source_ids[]","value":"2"}],"variable":[]}},"response":[],"_postman_id":"7bfbd470-a972-471e-a7a3-769105ccc7b8"}],"id":"d340bf37-8177-4cf5-9da8-750ab5cf20e6","_postman_id":"d340bf37-8177-4cf5-9da8-750ab5cf20e6","description":""},{"name":"Users","item":[{"name":"Get users","id":"7da4413b-df51-4c9f-93b7-ab43541c90a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/users","urlObject":{"protocol":"https","path":["api","v1","users"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7da4413b-df51-4c9f-93b7-ab43541c90a3"},{"name":"Create users","id":"0c9f42f7-2275-4b48-adeb-855bfa5921d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spree-Token","type":"text","value":"API_KEY"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": { \n\t\"email\": \"customer@email.com\",\n\t\"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"can_login\": \"true\",\n \"client_id\": 1,\n \"client_ids\": [2, 3, 4]\n }\n}"},"url":"https://parentorg.kallberg.me/api/v1/users","urlObject":{"protocol":"https","path":["api","v1","users"],"host":["parentorg","kallberg","me"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c9f42f7-2275-4b48-adeb-855bfa5921d6"}],"id":"07be2258-5add-45f1-92ca-c7a68a862262","_postman_id":"07be2258-5add-45f1-92ca-c7a68a862262","description":""},{"name":"Widgets","item":[{"name":"List widgets","id":"e16dfcb0-96fc-4077-893f-bf2d69f15f52","request":{"method":"GET","header":[{"key":"X-Spree-Token","value":"API_KEY"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/widgets","urlObject":{"protocol":"https","path":["api","v1","widgets"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e16dfcb0-96fc-4077-893f-bf2d69f15f52"},{"name":"View widget","id":"df70d850-50d7-4c05-81ee-c12efb5416b3","request":{"method":"GET","header":[{"key":"X-Spree-Token","value":"API_KEY"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://subdomain.reviewshake.com/api/v1/widgets/1","urlObject":{"protocol":"https","path":["api","v1","widgets","1"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"df70d850-50d7-4c05-81ee-c12efb5416b3"},{"name":"Create widget","id":"2bd6fd01-4dad-46d8-ad26-dd0822f441f2","request":{"method":"POST","header":[{"key":"X-Spree-Token","value":"API_KEY"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"widget_type\": \"List\",\n \"ex_star_rating\": [1,2,3],\n \"max_reviews\": 15\n}"},"url":"https://subdomain.reviewshake.com/api/v1/widgets","description":"

You can create the following widget types:

List
Caroussel
Slider
Grid
Quote

\n","urlObject":{"protocol":"https","path":["api","v1","widgets"],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2bd6fd01-4dad-46d8-ad26-dd0822f441f2"},{"name":"Update widget","id":"28c92ae7-bc5d-41d5-880a-f5c562caf3b8","request":{"method":"PUT","header":[{"key":"X-Spree-Token","value":"API_KEY"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://subdomain.reviewshake.com/api/v1/widgets/","urlObject":{"protocol":"https","path":["api","v1","widgets",""],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"28c92ae7-bc5d-41d5-880a-f5c562caf3b8"},{"name":"Delete widget","id":"53e58081-6970-4a7d-902b-fea883644087","request":{"method":"DELETE","header":[{"key":"X-Spree-Token","value":"API_KEY"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://subdomain.reviewshake.com/api/v1/widgets/","urlObject":{"protocol":"https","path":["api","v1","widgets",""],"host":["subdomain","reviewshake","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"53e58081-6970-4a7d-902b-fea883644087"}],"id":"433fd8d8-9085-45f2-b179-47622ba2941f","_postman_id":"433fd8d8-9085-45f2-b179-47622ba2941f","description":""}],"event":[{"listen":"prerequest","script":{"id":"8f5a02de-d49f-41a8-86c3-13e47be59593","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aedc1c3b-ac74-4e9a-ae3d-9f6d9a242b4d","type":"text/javascript","exec":[""]}}]}