Introduction

This document serves as an introduction to the Roomstyler RESTful API. The API exists so that you as a user or a whitelabel can communicate with our services through your own back-end. The API uses the JSON format for requests as well as responses. Aside from being able to send parameters using a query string (www.myurl.com?a=2&b=33) or through form fields in a POST request, you can also use a JSON formatted body, in which case you will have to set the content-type header to Content-type: application/json.

Table of Contents

PHP API wrapper

If you’re using PHP as a programming language you’re in luck! There is a PHP wrapper for our API which you can find on our company github page. It’s easy to install and use, it will save you lots of pain when it comes to dealing with errors and will allow you to work on your application instead of having to manually build these API calls.

Examples (using cURL)

Using a query string

curl -X GET "https://roomstyler.com/api/rooms?limit=10&skip_total=true&skip_last_updated=true"

Using a JSON body

curl -X GET "https://roomstyler.com/api/rooms" -H "Content-type: application/json" -d '{"limit": 10, "skip_total": true, "skip_last_updated": true}'

Or (different request) using form fields

note: when trying this request using a terminal, be aware that the history command will show all executed commands in the past including parameters passed!

curl -X POST "https://roomstyler.com/api/rooms" -F "email=example@roomstyler.com" -F "password=secret"

Parameter notation

Almost every API call requires parameters, therefore it is important to understand how these parameters work.

Sometimes, a parameter gets defined in the URL schema of a call:

GET/users/:id

If you want to fetch a user with an ID of say 972691 your request url will look like the following /users/972619, it will not be valid if it’s passed as a GET, POST or JSON parameter.

You’ll always be able to see if a parameter needs to be part of the URL by checking wether it is preceded by a colon in either the URL scheme or the parameter description table. :id would require an ID being present in the URL, the URL scheme will show you where to put the ID.

As it happens, our API also uses nested resources sometimes. This is currently true for 2 requests, commenting on a room and creating a user. When this happens, you’ll see this in the parameter description table:

Parameter Required Value
user[username] yes The display name of the user
user[email] yes The email address of the user
user[password] yes The password of the user

This basically means that the parameters need to be passed nested within a user parameter. A cURL example of this would look like this (the request will fail, it is there to give you an idea of parameter structure.):

curl -X POST "https://roomstyler.com/api/users" -H 'Content-type: application/json' -d '{"user": {"username": "myusername", "email": "myemail@domain.com", "password": "some_password"}}'

If you’re not familiar with cURL, here is the same example using a HTML form to post to the server (this will also fail)

<form action="https://roomstyler.com/api/users" method="post">
    <input required type="text" name="user[username]" />
    <input required type="text" name="user[email]" />
    <input required type="password" name="user[password]" />
    <input type="submit" value="Register" name="register" />
</form>

Authentication

There are three different ways to communicate with our API. The most simple approach would be anonymously as we provide some data publicly. The second approach uses http basic authentication and is meant to be used by retailers (whitelabels). And last but not least the third approach uses a token parameter specified either in the url, json body or post fields, this is used for commenting, liking, etc… since these actions require you to be logged in as a user.

Anonymous

If no credentials are passed (HTTP Basic nor token) you’ll be treated as an anonymous user, allowing you to read public Rooms, Users, Contests and Collections.

HTTP Basic

If you own a whitelabel account you can login using your whitelabel domain name and provided password.

Parameter Required Value
username yes whitelabel name (bold part: whitelabel.roomstyler.com)
password yes whitelabel password (provided by floorplanner)

Token

You can also perform actions like commenting or liking a room by logging in and using a token to authenticate requests. The token returned must be used in a different request that requires user authentication (not whitelabel authentication!)

API endpoints

All the API endpoints use a base url:

URLhttps://roomstyler.com/api

This means that when you see a path like /rooms in the url scheme of a request your url will look like:

URLhttps://roomstyler.com/api/rooms

If you own a whitelabel, your base URL also includes your whitelabel’s subdomain name:

URLhttps://whitelabelname.roomstyler.com/api

Rooms

Index

GET /rooms
Parameter Required Value
limit yes between (inclusive) 1 and 50, automatically set to 50 if number is not within that range
skip_total no Recommended (default false) - true or false, skips counting all rooms, significantly speeds up the request
skip_last_updated no Recommended (default false) - true or false, skips fetching last updated room, speeds up the request
offset no Default 0, allow results to be paginated
user_id no List rooms owned by this user
category no Find rooms in a specific category
created no List rooms created after (or equal to) given timestamp (ISO formatted, e.g. "2016-01-01 00:00:00" (YYYY-MM-DD HH:MM:SS))
last_updated no Like created but instead filters on update date rather than creation date. When both created and last_updated are passed, both will be checked and honored in the query
order no Order results by specific attribute. (Check response within “success” tab for returned attributes)
Direction yes if order is specified asc or desc
whitelabel no Filter rooms by given whitelabel (whitelabel name must be passed, this is the part before “.roomstyler.com” e.g. whitelabel in “whitelabel.roomstyler.com”)
tag no Filter rooms by given tag
HTTP200
{
   "total" : 1116228,
   "rooms" : [
      {
         "category" : "Living room",
         "url" : "https://roomstyler.com/3dplanner/rooms/162/164",
         "has_panorama" : false,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/164.jpg",
         "id" : 162,
         "last_updated" : "2007-12-28T11:32:15+00:00",
         "created" : "2007-10-30T20:41:39+00:00",
         "public" : true,
         "source_id" : null,
         "name" : "Living room bay window",
         "user_id" : 486,
         "hq_image_url" : null
      },
      {
         "last_updated" : "2007-10-30T20:41:39+00:00",
         "created" : "2007-10-30T20:41:39+00:00",
         "id" : 247,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
         "has_panorama" : false,
         "url" : "https://roomstyler.com/3dplanner/rooms/247/247",
         "category" : "Living room",
         "hq_image_url" : null,
         "user_id" : 87,
         "source_id" : null,
         "name" : "Living room",
         "public" : true
      },
      {
         "source_id" : null,
         "name" : "My Project",
         "user_id" : 499,
         "hq_image_url" : null,
         "public" : true,
         "has_panorama" : false,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/299.jpeg",
         "id" : 265,
         "last_updated" : "2008-02-13T19:51:49+00:00",
         "created" : "2008-02-13T19:51:49+00:00",
         "category" : "",
         "url" : "https://roomstyler.com/3dplanner/rooms/265/299"
      },
      {
         "created" : "2007-10-30T20:41:39+00:00",
         "last_updated" : "2007-12-14T17:00:04+00:00",
         "id" : 269,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/426.jpg",
         "has_panorama" : false,
         "url" : "https://roomstyler.com/3dplanner/rooms/269/426",
         "category" : "",
         "hq_image_url" : null,
         "user_id" : 90,
         "source_id" : null,
         "name" : "test room 2",
         "public" : true
      },
      {
         "user_id" : 482,
         "hq_image_url" : null,
         "name" : "Lounge",
         "source_id" : null,
         "public" : true,
         "id" : 286,
         "created" : "2007-10-30T20:41:39+00:00",
         "last_updated" : "2007-10-30T20:41:39+00:00",
         "has_panorama" : false,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/287.jpg",
         "url" : "https://roomstyler.com/3dplanner/rooms/286/287",
         "category" : ""
      }
   ],
   "last_updated" : "2016-07-01T10:43:42+00:00"
}

Show

GET/rooms/:id
Parameter Required Value
:id yes Target room ID
skip_model no Recommended - true or false, skips fetching the (usually large) model data from the database, significantly speeds up the request
HTTP200
{
   "tags" : [],
   "has_panorama" : false,
   "created" : "2009-12-10T22:03:13+00:00",
   "hq_image_url" : null,
   "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/mppw7dpicxkyambp.jpeg",
   "last_updated" : "2016-04-23T02:57:09+01:00",
   "name" : "Master Bedroom  - 22 Dec 2009 6:27:42 PM",
   "category" : "Bedroom",
   "url" : "https://roomstyler.com/3dplanner/rooms/545089/5664456",
   "source_id" : null,
   "user_id" : 89117,
   "id" : 545089,
   "model" : {
      "materials" : [
         {
            "ID" : "decor-3630",
            "ambient" : [
               0.052549,
               0.0498039,
               0.0435294
            ],
            "diffuse_texture" : "floor_and_wall/original/231389872.jpg",
            "diffuse" : [
               0.52549,
               0.498039,
               0.435294
            ],
            "shader" : "combi_material",
            "texture_width" : "52"
         },
         {
            "shiny" : 20,
            "ID" : "decor-2650",
            "texture_width" : "100",
            "shader" : "combi_material",
            "diffuse_texture" : "W_AL_UKR0315.jpg",
            "diffuse" : [
               1,
               1,
               1
            ]
         },
         {
            "ambient" : [
               0.0890196,
               0.0858824,
               0.0784314
            ],
            "ID" : "decor-3564",
            "shader" : "combi_material",
            "texture_width" : "52",
            "diffuse_texture" : "floor_and_wall/original/Sanderson_Vermicelli_Wallpaper_Taupe_DOPWVE105.jpeg",
            "diffuse" : [
               0.890196,
               0.858824,
               0.784314
            ]
         },
         {
            "shiny" : 20,
            "ID" : "decor-2660",
            "shader" : "combi_material",
            "texture_width" : "100",
            "diffuse_texture" : "None",
            "diffuse" : [
               1,
               1,
               1
            ]
         }
      ],
      "components" : [
         {
            "model" : "models/81/816c94e0931b145416e9f8acf8bc758c6209f155_02.mi",
            "bounding_box" : [
               [
                  -91.5,
                  -130,
                  0
               ],
               [
                  91.5,
                  130,
                  1.5
               ]
            ],
            "type" : "Component",
            "rotation" : [
               270,
               0,
               0
            ],
            "surface_height" : 0,
            "ID" : "model-4",
            "level" : -1,
            "position" : [
               293.792264708259,
               348.159953649299,
               130
            ],
            "parentID" : "8",
            "component_id" : "816c94e0931b145416e9f8acf8bc758c6209f155"
         },
         {
            "parentID" : "8",
            "position" : [
               110.79047944015,
               348.159953649299,
               114
            ],
            "component_id" : "816c94e0931b145416e9f8acf8bc758c6209f155",
            "bounding_box" : [
               [
                  -91.5,
                  -130,
                  0
               ],
               [
                  91.5,
                  130,
                  1.5
               ]
            ],
            "model" : "models/81/816c94e0931b145416e9f8acf8bc758c6209f155_02.mi",
            "rotation" : [
               270,
               0,
               0
            ],
            "type" : "Component",
            "surface_height" : 0,
            "level" : -1,
            "ID" : "model-5"
         },
         {
            "area" : "area0",
            "position" : [
               156.718120425232,
               255.642809787138,
               155.581
            ],
            "parentID" : "0",
            "component_id" : "a36360680507ff5385068c8e915c869985a3e23e",
            "model" : "models/a3/a36360680507ff5385068c8e915c869985a3e23e_01.mi",
            "bounding_box" : [
               [
                  -30.374,
                  -160.543,
                  7.524
               ],
               [
                  30.374,
                  150.619,
                  10.701
               ]
            ],
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "type" : "Component",
            "surface_height" : 0.1,
            "ID" : "model-6",
            "level" : -1
         },
         {
            "surface_height" : 0,
            "ID" : "model-7",
            "level" : -1,
            "model" : "models/55/55132835a343915683e36ce323c45a49a0cbb2d8_00.mi",
            "bounding_box" : [
               [
                  -150.199,
                  -10.037,
                  -0.124
               ],
               [
                  150.217,
                  10.037,
                  19.95
               ]
            ],
            "type" : "Component",
            "rotation" : [
               270,
               0,
               90
            ],
            "position" : [
               273.083750012089,
               -29.2480790987097,
               233.963
            ],
            "parentID" : "1",
            "component_id" : "55132835a343915683e36ce323c45a49a0cbb2d8",
            "area" : "area0"
         },
         {
            "component_id" : "55132835a343915683e36ce323c45a49a0cbb2d8",
            "position" : [
               273.083750012089,
               114.489359191928,
               233.963
            ],
            "parentID" : "1",
            "area" : "area0",
            "ID" : "model-8",
            "level" : -1,
            "surface_height" : 0,
            "rotation" : [
               270,
               0,
               90
            ],
            "type" : "Component",
            "model" : "models/55/55132835a343915683e36ce323c45a49a0cbb2d8_00.mi",
            "bounding_box" : [
               [
                  -150.199,
                  -10.037,
                  -0.124
               ],
               [
                  150.217,
                  10.037,
                  19.95
               ]
            ]
         },
         {
            "type" : "Component",
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "model" : "models/55/55132835a343915683e36ce323c45a49a0cbb2d8_00.mi",
            "bounding_box" : [
               [
                  -150.199,
                  -10.037,
                  -0.124
               ],
               [
                  150.217,
                  10.037,
                  19.95
               ]
            ],
            "ID" : "model-9",
            "level" : -1,
            "surface_height" : 0,
            "area" : "area0",
            "component_id" : "55132835a343915683e36ce323c45a49a0cbb2d8",
            "position" : [
               -56.3696960505396,
               255.629643126464,
               233.963
            ],
            "parentID" : "0"
         },
         {
            "level" : -1,
            "ID" : "model-10",
            "surface_height" : 0,
            "type" : "Component",
            "rotation" : [
               270,
               0,
               -180
            ],
            "bounding_box" : [
               [
                  -150.199,
                  -10.037,
                  -0.124
               ],
               [
                  150.217,
                  10.037,
                  19.95
               ]
            ],
            "model" : "models/55/55132835a343915683e36ce323c45a49a0cbb2d8_00.mi",
            "component_id" : "55132835a343915683e36ce323c45a49a0cbb2d8",
            "parentID" : "7",
            "position" : [
               5.22296080169438,
               -171.55,
               233.963
            ],
            "area" : "area0"
         },
         {
            "type" : "Component",
            "rotation" : [
               270,
               0,
               -180
            ],
            "bounding_box" : [
               [
                  -150.199,
                  -10.037,
                  -0.124
               ],
               [
                  150.217,
                  10.037,
                  19.95
               ]
            ],
            "model" : "models/55/55132835a343915683e36ce323c45a49a0cbb2d8_00.mi",
            "level" : -1,
            "ID" : "model-11",
            "surface_height" : 0,
            "area" : "area0",
            "component_id" : "55132835a343915683e36ce323c45a49a0cbb2d8",
            "parentID" : "7",
            "position" : [
               134.513361507371,
               -171.55,
               233.963
            ]
         },
         {
            "area" : "area0",
            "position" : [
               133.645009900386,
               255.641384103483,
               233.963
            ],
            "parentID" : "0",
            "component_id" : "55132835a343915683e36ce323c45a49a0cbb2d8",
            "model" : "models/55/55132835a343915683e36ce323c45a49a0cbb2d8_00.mi",
            "bounding_box" : [
               [
                  -150.199,
                  -10.037,
                  -0.124
               ],
               [
                  150.217,
                  10.037,
                  19.95
               ]
            ],
            "type" : "Component",
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "surface_height" : 0,
            "ID" : "model-12",
            "level" : -1
         },
         {
            "component_id" : "ca82dd621472d024e550af7de70056558f96864b",
            "parentID" : "1",
            "position" : [
               273.083750012089,
               143.113,
               7.641
            ],
            "area" : "area0",
            "level" : -1,
            "ID" : "model-13",
            "surface_height" : 0,
            "rotation" : [
               270,
               0,
               90
            ],
            "type" : "Component",
            "bounding_box" : [
               [
                  -112.537,
                  -7.641,
                  0.003
               ],
               [
                  112.537,
                  7.641,
                  1.675
               ]
            ],
            "model" : "models/ca/ca82dd621472d024e550af7de70056558f96864b_00.mi"
         },
         {
            "area" : "area0",
            "parentID" : "1",
            "position" : [
               273.083750012089,
               -66.3530315426104,
               7.641
            ],
            "component_id" : "ca82dd621472d024e550af7de70056558f96864b",
            "bounding_box" : [
               [
                  -112.537,
                  -7.641,
                  0.003
               ],
               [
                  112.537,
                  7.641,
                  1.675
               ]
            ],
            "model" : "models/ca/ca82dd621472d024e550af7de70056558f96864b_00.mi",
            "type" : "Component",
            "rotation" : [
               270,
               0,
               90
            ],
            "surface_height" : 0,
            "level" : -1,
            "ID" : "model-14"
         },
         {
            "ID" : "model-15",
            "level" : -1,
            "surface_height" : 0,
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "type" : "Component",
            "model" : "models/ca/ca82dd621472d024e550af7de70056558f96864b_00.mi",
            "bounding_box" : [
               [
                  -112.537,
                  -7.641,
                  0.003
               ],
               [
                  112.537,
                  7.641,
                  1.675
               ]
            ],
            "component_id" : "ca82dd621472d024e550af7de70056558f96864b",
            "position" : [
               171.796530694505,
               255.643741479596,
               7.641
            ],
            "parentID" : "0",
            "area" : "area0"
         },
         {
            "surface_height" : 0,
            "ID" : "model-16",
            "level" : -1,
            "model" : "models/ca/ca82dd621472d024e550af7de70056558f96864b_00.mi",
            "bounding_box" : [
               [
                  -112.537,
                  -7.641,
                  0.003
               ],
               [
                  112.537,
                  7.641,
                  1.675
               ]
            ],
            "type" : "Component",
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "position" : [
               -46.7013198787601,
               255.630240533817,
               7.641
            ],
            "parentID" : "0",
            "component_id" : "ca82dd621472d024e550af7de70056558f96864b",
            "area" : "area0"
         },
         {
            "component_id" : "ca82dd621472d024e550af7de70056558f96864b",
            "parentID" : "0",
            "position" : [
               -96.5581433494053,
               255.627159889002,
               7.641
            ],
            "area" : "area0",
            "level" : -1,
            "ID" : "model-17",
            "surface_height" : 0,
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "type" : "Component",
            "bounding_box" : [
               [
                  -112.537,
                  -7.641,
                  0.003
               ],
               [
                  112.537,
                  7.641,
                  1.675
               ]
            ],
            "model" : "models/ca/ca82dd621472d024e550af7de70056558f96864b_00.mi"
         },
         {
            "surface_height" : 0,
            "level" : -1,
            "ID" : "model-18",
            "bounding_box" : [
               [
                  -112.537,
                  -7.641,
                  0.003
               ],
               [
                  112.537,
                  7.641,
                  1.675
               ]
            ],
            "model" : "models/ca/ca82dd621472d024e550af7de70056558f96864b_00.mi",
            "type" : "Component",
            "rotation" : [
               270,
               0,
               -180
            ],
            "parentID" : "7",
            "position" : [
               -33.1143759062492,
               -171.55,
               7.641
            ],
            "component_id" : "ca82dd621472d024e550af7de70056558f96864b",
            "area" : "area0"
         },
         {
            "component_id" : "a36360680507ff5385068c8e915c869985a3e23e",
            "position" : [
               -88.3176992514199,
               255.62766906467,
               88.419
            ],
            "parentID" : "0",
            "area" : "area0",
            "ID" : "model-19",
            "level" : -1,
            "surface_height" : 0.1,
            "rotation" : [
               270,
               0,
               -0.00354029666453926
            ],
            "type" : "Component",
            "model" : "models/a3/a36360680507ff5385068c8e915c869985a3e23e_01.mi",
            "bounding_box" : [
               [
                  -30.374,
                  -160.543,
                  7.524
               ],
               [
                  30.374,
                  150.619,
                  10.701
               ]
            ]
         },
         {
            "model" : "models/b3/b34e1c9e6cde2299aa0260cd31e22c22e8459c43_00.mi",
            "bounding_box" : [
               [
                  -120.143,
                  -152.849,
                  0
               ],
               [
                  120.143,
                  152.849,
                  1
               ]
            ],
            "type" : "Component",
            "rotation" : [
               0,
               0,
               0
            ],
            "surface_height" : 1,
            "ID" : "model-24",
            "level" : 0,
            "position" : [
               83.8356191145482,
               43.5332732100768,
               0
            ],
            "parentID" : null,
            "component_id" : "b34e1c9e6cde2299aa0260cd31e22c22e8459c43"
         },
         {
            "component_id" : "8c28aaab54d164f1abab9706706925686e013369",
            "position" : [
               59.8746098947296,
               -183.961990554745,
               0
            ],
            "parentID" : null,
            "ID" : "model-26",
            "level" : 1,
            "category" : null,
            "surface_height" : 200,
            "rotation" : [
               0,
               0,
               180
            ],
            "type" : "Component",
            "model" : "models/8c/8c28aaab54d164f1abab9706706925686e013369_01.mi",
            "bounding_box" : [
               [
                  -70.047,
                  -20.064,
                  0
               ],
               [
                  70.047,
                  20.064,
                  200.279
               ]
            ]
         },
         {
            "surface_height" : 0.1,
            "level" : 1,
            "category" : null,
            "ID" : "model-27",
            "bounding_box" : [
               [
                  -22.5,
                  -15,
                  0
               ],
               [
                  22.5,
                  15,
                  31
               ]
            ],
            "model" : "models/dd/ddbfeb8f741b769a64acd690e7e20f7d378cfa16_00.mi",
            "rotation" : [
               0,
               0,
               90
            ],
            "type" : "Component",
            "parentID" : null,
            "position" : [
               147.7,
               63.1,
               1
            ],
            "component_id" : "ddbfeb8f741b769a64acd690e7e20f7d378cfa16"
         }
      ],
      "plan" : {
         "walls" : {
            "wall7" : {
               "material" : "decor-3630",
               "indices" : [
                  5,
                  2
               ],
               "thickness" : 17
            },
            "wall8" : {
               "material" : "decor-3630",
               "thickness" : 17,
               "indices" : [
                  6,
                  7
               ]
            },
            "wall6" : {
               "thickness" : 17,
               "indices" : [
                  1,
                  5
               ],
               "material" : "decor-3630"
            },
            "wall0" : {
               "thickness" : 17,
               "indices" : [
                  3,
                  0
               ],
               "material" : "decor-3630"
            }
         },
         "height" : 244,
         "points" : [
            [
               -197.835175055037,
               255.620901998088
            ],
            [
               -136.069073182046,
               -111.035673802538
            ],
            [
               273.083750012089,
               -171.55
            ],
            [
               273.083750012089,
               255.65
            ],
            [
               -197.835175055037,
               -111.035673802538
            ]
         ],
         "areas" : {
            "area0" : {
               "indices" : [
                  3,
                  2,
                  5,
                  1,
                  4,
                  0
               ],
               "ceiling_material" : "decor-3564",
               "floor_material" : "decor-2650"
            }
         }
      },
      "lights" : [
         {
            "type" : "sun",
            "direction" : [
               0,
               0,
               -500
            ],
            "position" : [
               10,
               0,
               500
            ]
         }
      ],
      "environment" : {
         "image" : null
      },
      "version" : 2,
      "camera" : {
         "exposure" : 0,
         "hq_renderer" : "realityserver",
         "focal_point" : [
            112.009784088047,
            84.825485283432,
            104.608403368484
         ],
         "position" : [
            -195.047606127286,
            -0.99862199505379,
            104.608403368484
         ]
      },
      "room_id" : 0
   },
   "public" : true
}

Room not found

HTTP404

Room is private

This can happen if you aren't logged in to the API and are trying to access one of your account's private rooms or if you're trying to access another user's private room. HTTP403
GET/rooms/search
Parameter Required Value
limit yes between (inclusive) 0 and 50
q no A search string
page no A number that indicates the page you are on (and offset using limit * (page - 1))
since no See Search meta for options
category no See Search meta for options
style no See Search meta for options
kind no If given and own, search through logged in users rooms, otherwise ignored
HTTP200
{
   "rooms" : [
      {
         "url" : "https://roomstyler.com/3dplanner/rooms/1151151/1151152",
         "name" : "paradi",
         "created" : "2010-10-27T13:41:18+01:00",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/yobylmceo6kjqrft.jpeg",
         "category" : "Garden",
         "user_id" : 84129,
         "public" : true,
         "source_id" : null,
         "last_updated" : "2016-07-01T06:22:45+01:00",
         "has_panorama" : false,
         "id" : 1151151,
         "hq_image_url" : null
      },
      {
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/gly5lkubzyplrnum.jpeg",
         "name" : "Breakfast Nook",
         "created" : "2013-10-04T05:01:58+01:00",
         "url" : "https://roomstyler.com/3dplanner/rooms/5532996/5532997",
         "user_id" : 174318,
         "category" : "Dining room",
         "source_id" : 5531152,
         "public" : true,
         "id" : 5532996,
         "has_panorama" : false,
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/5532997-1443517290.jpeg",
         "last_updated" : "2016-06-30T06:25:20+01:00"
      }
   ],
   "total" : 1116182,
   "last_updated" : null
}

No limit supplied

HTTP422
{
   "error" : "Limit should be between 1 and 50"
}

Search meta

Search meta returns a list of styles, categories and timeframes which can be used to filter results in requests that specify a style, category or since parameter, or any combination of those three.

GET/rooms/search/meta
HTTP200
{
   "styles" : [
      {
         "name" : "All",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/yobylmceo6kjqrft.jpeg",
         "key" : ""
      },
      {
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/3m3rpqvjp6yuuhjk.jpeg",
         "name" : "Modern",
         "key" : "Modern"
      },
      {
         "name" : "Eclectic",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/hamjovjhabkhfu4q.jpeg",
         "key" : "Eclectic"
      },
      {
         "key" : "Classic",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/adylmmx34th3gb55.jpeg",
         "name" : "Classic"
      },
      {
         "key" : "Country",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/rkwweahthlyo3tud.jpeg",
         "name" : "Country"
      },
      {
         "name" : "Glamour",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/NGAcALdcU4SxUwIw.jpg",
         "key" : "Glamour"
      },
      {
         "name" : "Minimal",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/wJadCfTKB9_EYCNt.jpg",
         "key" : "Minimal"
      },
      {
         "key" : "Retro",
         "name" : "Retro",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/xMPRVMUsm8TtHoot.jpg"
      },
      {
         "key" : "Rustic",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/GGlVa5UOsmDhJGIP.jpg",
         "name" : "Rustic"
      },
      {
         "key" : "Vintage",
         "name" : "Vintage",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/ZHkDo_vTp0Gk9ClP.jpg"
      },
      {
         "name" : "Other",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/_thumbs/ZM40hNzrDxnEDoWE.jpg_960x540_q85.jpg",
         "key" : "Other"
      }
   ],
   "timeframes" : [
      {
         "key" : "",
         "name" : "All time"
      },
      {
         "name" : "Today",
         "key" : "Today"
      },
      {
         "key" : "This week",
         "name" : "This week"
      },
      {
         "name" : "This month",
         "key" : "This month"
      }
   ],
   "categories" : [
      {
         "key" : "",
         "name" : "All",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/gly5lkubzyplrnum.jpeg"
      },
      {
         "name" : "Kitchen",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/chpiOmfYmgQHUHXa.jpg",
         "key" : "Kitchen"
      },
      {
         "key" : "Bathroom",
         "name" : "Bath",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/mLceRkzA3Dhs43A-.jpg"
      },
      {
         "name" : "Bedroom",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/KWJ2wzQW0l2rU26O.jpg",
         "key" : "Bedroom"
      },
      {
         "name" : "Living",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/3m3rpqvjp6yuuhjk.jpeg",
         "key" : "Living room"
      },
      {
         "name" : "Dining room",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/657o6ly4jzlkr6gh.jpeg",
         "key" : "Dining Room"
      },
      {
         "key" : "Garden",
         "name" : "Garden",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/wZy8erZHrVPtWdO6.jpg"
      },
      {
         "key" : "Kids room",
         "name" : "Kids",
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/iswacetxg3mzamwd.jpeg"
      },
      {
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/q74hqrJhr4nmnWRK.jpg",
         "name" : "Office",
         "key" : "Office"
      },
      {
         "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/media/data/rooms/images/HqknDff6UWi27krR.jpg",
         "name" : "Other",
         "key" : "Other"
      }
   ]
}

Panorama’s

Fetch a list of panorama’s.

GET/rooms/panoramas
Parameter Required Value
limit yes between (inclusive) 0 and 50
page no A number that indicates the page you are on (and offset using limit (page - 1))
since no See Search meta for options
skip_total no true or false, skips counting returned panoramas
HTTP200
{
   "total" : 5,
   "last_updated" : null,
   "rooms" : [
      {
         "created" : "2013-05-19T02:21:27+01:00",
         "name" : "Infinity Pool III",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/4698565-1401505467.jpeg",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/wgz73z5iz3gt7t4i.jpeg",
         "source_id" : 4698103,
         "last_updated" : "2016-06-26T09:08:50+01:00",
         "url" : "https://roomstyler.com/3dplanner/rooms/4698454/4698565",
         "id" : 4698454,
         "has_panorama" : true,
         "user_id" : 506091,
         "public" : true,
         "category" : "Living room"
      },
      {
         "has_panorama" : true,
         "user_id" : 733846,
         "public" : true,
         "category" : "Other",
         "created" : "2014-06-27T21:01:15+01:00",
         "name" : "Double Dutch",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/7038624-1456397578.jpeg",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/S4EZ-FOHfclvjTZK.jpg",
         "source_id" : 7034952,
         "last_updated" : "2016-06-29T19:21:30+01:00",
         "url" : "https://roomstyler.com/3dplanner/rooms/7038623/7038624",
         "id" : 7038623
      },
      {
         "category" : "Living room",
         "public" : true,
         "user_id" : 733846,
         "has_panorama" : true,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/FABtXZDSNMMgkVH7.jpg",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13638645-1463671439.jpeg",
         "name" : "Summer Beach House",
         "created" : "2016-05-13T04:29:39+01:00",
         "id" : 13631343,
         "url" : "https://roomstyler.com/3dplanner/rooms/13631343/13638645",
         "last_updated" : "2016-06-28T14:55:51+01:00",
         "source_id" : 13630435
      },
      {
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13289376-1461252814.jpeg",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/WkkhgZN0_1zOj6Xp.jpg",
         "created" : "2016-04-20T16:39:04+01:00",
         "name" : "M_White and naturel",
         "url" : "https://roomstyler.com/3dplanner/rooms/13289339/13289376",
         "id" : 13289339,
         "source_id" : null,
         "last_updated" : "2016-06-29T22:41:05+01:00",
         "public" : true,
         "category" : "Bedroom",
         "has_panorama" : true,
         "user_id" : 182217
      },
      {
         "name" : "Big Family Kitchen",
         "created" : "2016-05-31T18:20:51+01:00",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/qvKpkqHNDZJgp-_x.jpg",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13909831-1465204693.jpeg",
         "last_updated" : "2016-07-01T05:53:30+01:00",
         "source_id" : 13891728,
         "id" : 13909830,
         "url" : "https://roomstyler.com/3dplanner/rooms/13909830/13909831",
         "user_id" : 1018947,
         "has_panorama" : true,
         "category" : "Kitchen",
         "public" : true
      }
   ]
}

Panorama is private

This can happen if you aren't logged in to the API and are trying to access one of your account's private rooms or if you're trying to access another user's private room. HTTP403

Panorama not found

HTTP404

Panorama

Fetch a specific room panorama.

GET/rooms/:id/panorama
Parameter Required Value
:id yes Target ID of the room from which you want to retrieve a panorama.
krpano_url no When supplied, adds a krpano_url property containing a template url to use for rendering a cube image in krpano.
HTTP200
{
   "images" : {
      "r" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/18923/left/r.jpg",
      "d" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/18923/left/d.jpg",
      "l" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/18923/left/l.jpg",
      "u" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/18923/left/u.jpg",
      "b" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/18923/left/b.jpg",
      "f" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/18923/left/f.jpg"
   },
   "updated_at" : "2016-07-21T16:02:18+01:00",
   "room_id" : 14075620,
   "type" : "PanoramaRender",
   "retry_parent_id" : null,
   "id" : 18923,
   "status" : "success",
   "path" : null,
   "created_at" : "2016-07-21T16:00:20+01:00",
   "transaction_id" : null,
   "width" : 1080,
   "height" : 1080,
   "satisfied" : null
}

Panorama not found

HTTP404

Comment

Only regular authenticated users can post a comment on a room. Posting a comment requires a token to also be present among the other parameters.

POST/rooms/:id/comments
Parameter Required Value
:id yes Target room ID
comment[comment] yes The comment body
HTTP201
{
   "created" : "2016-07-01T14:46:59+01:00",
   "user_id" : 1349271,
   "id" : 348540,
   "comment" : "Hello there!"
}

Room is private

This can happen if you try to comment on a room that isn't public or if you try to comment on a room without being logged in. HTTP403

Toggle love

Only regular authenticated users can toggle a love on a room. Toggling a love requires a token to also be present among the other parameters.

POST/rooms/:id/toggle_like
Parameter Required Value
:id yes Target room ID
HTTP200

Room is private

This can happen if you try to love on a room that isn't public or if you try to love a room without being logged in. HTTP403

Change owner

Only whitelabel admin accounts can change the owner of a room. Changing the owner of the room through a whitelabel account requires authentication through http basic.

POST/rooms/:id/chown
Parameter Required Value
:id yes Target room ID
user_id yes Target user ID, Must be a user of your whitelabel
HTTP200

Room not owned by user or whitelabel

HTTP403

User or Room not found

HTTP404

Not a 3D Room

HTTP422

Destroy

Only regular authenticated users can delete a room. Deleting a room requires a token to also be present among the other parameters.

DELETE/rooms/:id
Parameter Required Value
:id yes Target room ID
HTTP200

Room not owned by user or whitelabel

HTTP403

Room not found

HTTP404

Room used in contest

When a room is used in a contest it cannot be deleted. HTTP422

Products

GET/rooms/:id/products
Parameter Required Value
:id yes Target room ID
HTTP200
[
   {
      "supplier_id" : 6912519,
      "count" : 1,
      "out_of_stock" : false,
      "has_special_price" : false,
      "price" : 17.95,
      "level" : 2,
      "bbox_min" : [
         -10.75,
         -10.75,
         0
      ],
      "surface_height" : 1,
      "model" : "7aec926807a58f4ec2071758b4e6d46f91de9d08_00",
      "has_lights" : false,
      "url" : "http://www.lyttonandlily.co.uk/product/4647/Emma_Bridgewater_Starry_Skies_Pasta_Bowl",
      "name" : "Emma Bridgewater Starry Skies Pasta Bowl",
      "bbox_max" : [
         10.75,
         10.75,
         5
      ],
      "parent" : "GB697A07PLWJE2AHUWHU5QQHC5MLJZWUN6I55HII"
   },
   {
      "parent" : "GB69C183KQUBENFVDWSV45MBYC64QNSFRCXMEOPE",
      "bbox_max" : [
         5.804,
         3.966,
         10
      ],
      "name" : "Skyline - City view mugs",
      "has_lights" : false,
      "url" : "www.mwbex.com",
      "model" : "7bc8528050b98c9b07598139756cd475d4c7b4a0_00",
      "surface_height" : 0.1,
      "has_special_price" : false,
      "count" : 2,
      "supplier_id" : 6930819,
      "out_of_stock" : false,
      "bbox_min" : [
         -5.804,
         -3.966,
         0
      ],
      "level" : 2
   },
   {
      "surface_height" : 12,
      "model" : "7e9c03112926425435b8f5660ebcf52379a7c4e2_01",
      "level" : 2,
      "price" : 7.75,
      "description" : "Linea by Portmeirion Watercolour Floral Mug. 0.22ltr. Made from fine china.",
      "bbox_min" : [
         -6.402,
         -4.367,
         0
      ],
      "supplier_id" : 197,
      "count" : 1,
      "out_of_stock" : false,
      "has_special_price" : false,
      "parent" : "GB0000C5P2OAGEJJEZBFINNY6VTA5PHVEN42PRHC",
      "has_lights" : false,
      "url" : "http://mydeco.com/p/watercolour-floral-mug/7e9c03112926425435b8f5660ebcf52379a7c4e2/",
      "bbox_max" : [
         6.402,
         4.367,
         12.035
      ],
      "name" : "Watercolour Floral Mug"
   },
   {
      "url" : "http://mydeco.com/p/vintage-style-tea-cup-and-saucer/7ea006934dbdd3b84e1ca128d56370866f63082c/",
      "has_lights" : false,
      "bbox_max" : [
         8.653,
         8.663,
         8
      ],
      "name" : "Vintage-style tea cup and saucer",
      "parent" : "GB0000D4P2QANE2NXXJ3QTQ4UEUNKY3QQZXWGCBM",
      "count" : 1,
      "out_of_stock" : false,
      "supplier_id" : 212,
      "has_special_price" : false,
      "price" : 11,
      "level" : 2,
      "bbox_min" : [
         -8.653,
         -8.663,
         0
      ],
      "description" : "Adorable vintage-inspired ceramic tea cup and saucer, decorated with floral design and filled with a delicately scented candle.<p>We love these quirky tea cups! And the best thing about them is that they're two presents in one - once the candle has burnt down, you can use the cup and saucer for your favourite cuppa.</p><p>Available in blue flower, strawberries, dark pink flowers and vintage pink flowers. Height: 8cm; diameter of cup 10cm.</p>",
      "surface_height" : 8,
      "model" : "7ea006934dbdd3b84e1ca128d56370866f63082c_01"
   },
   {
      "parent" : "GB000254Q7W633MBCNCPZ25O2TKGA2JI6CS6TIFV",
      "bbox_max" : [
         4.865,
         1.779,
         2.202
      ],
      "name" : "Poinsettia gold napkin ring",
      "has_lights" : false,
      "url" : "http://www.cocomale.com/shop/christmas/poinsettia-gold-napkin-ring.html",
      "model" : "87ededed811344fcebaed4d4606928f0a5e9a0b5_01",
      "surface_height" : 2.2,
      "bbox_min" : [
         -4.865,
         -1.779,
         0
      ],
      "price" : 8,
      "level" : 2,
      "has_special_price" : false,
      "out_of_stock" : false,
      "count" : 5,
      "supplier_id" : 596
   },
   {
      "model" : "b876899518e106d33425418ebaee509d8b253d75_00",
      "surface_height" : 0.5,
      "bbox_min" : [
         -61,
         -61,
         0
      ],
      "price" : 179,
      "level" : -1,
      "has_special_price" : false,
      "count" : 1,
      "out_of_stock" : false,
      "supplier_id" : 426,
      "parent" : "GB0001AAXB3ITFIY4EDNGNBFIGHLV3SQTWFSKPLV",
      "bbox_max" : [
         61,
         61,
         2
      ],
      "name" : "Kevatjula - wall hanging",
      "has_lights" : false,
      "url" : "http://sheerhome.co.uk/productdetails.aspx?ref=670&m=5"
   },
   {
      "has_lights" : false,
      "url" : "http://www.bloom.uk.com/Silk_Flowers/Shop/Flowers/Tulips/1326_Tulip_bowl_Due_in_mid_February.html",
      "name" : "Tulip bowl Due in mid February",
      "bbox_max" : [
         10.945,
         13.279,
         21.999
      ],
      "parent" : "GB0000025RQG7CPQI5DKHQFUYPN3UCR25BS2XLM6",
      "supplier_id" : 2,
      "count" : 1,
      "out_of_stock" : false,
      "has_special_price" : false,
      "price" : 48,
      "level" : 2,
      "description" : "P&P PER DELIVERY ADDRESS:",
      "bbox_min" : [
         -12.24,
         -11.092,
         0
      ],
      "surface_height" : 22,
      "model" : "ec606f89f04746a3c0b4c3dbba0a3ae865abad9e_03"
   },
   {
      "model" : "f95a5f2a1f0cb5beba78f371b2102d6aa876a747_00",
      "surface_height" : 0.1,
      "has_special_price" : false,
      "supplier_id" : 6930958,
      "count" : 1,
      "out_of_stock" : false,
      "bbox_min" : [
         -10.806,
         -5.646,
         0
      ],
      "level" : 2,
      "parent" : "GB69C20E4FWACCLBI7AYCVLZYCT4PKJL32HWRWSI",
      "name" : "Bowl",
      "bbox_max" : [
         11.071,
         5.601,
         14.405
      ],
      "url" : "www.floorplanner.com",
      "has_lights" : false
   },
   {
      "has_lights" : false,
      "url" : "www.floorplanner.com",
      "bbox_max" : [
         10.506,
         10.487,
         9.49
      ],
      "name" : "Bowl",
      "parent" : "GB69C20EHWYA4CYRN2RIUL7MKGQGCE66BCN4CH5A",
      "level" : 2,
      "bbox_min" : [
         -10.506,
         -10.525,
         0
      ],
      "count" : 1,
      "supplier_id" : 6930958,
      "out_of_stock" : false,
      "has_special_price" : false,
      "surface_height" : 0.1,
      "model" : "1051215c901528b0a3ba7e760649aae88d2a909b_01"
   },
   {
      "parent" : "GB00017FDWJXSFYEPLZCG5WST2W5AKK6UG55DJOJ",
      "has_lights" : false,
      "url" : "http://biomelifestyle.com/products/bamboo-coasters-and-holder?start=0",
      "bbox_max" : [
         6.719,
         6.377,
         7.653
      ],
      "name" : "Bamboo coasters and holder",
      "surface_height" : 7.6,
      "model" : "1d937917047af22376d29eadd0295ea1bbd1a5c9_01",
      "level" : 2,
      "price" : 8,
      "description" : "<p> <br /> These coasters are part of the Biome Basics range, bringing you good quality, ethically sourced products which are essential for everyday living. </p> <p> Beautiful natural bamboo coasters in a set of 5, held in a lovely bamboo holder. </p> <p> Bamboo is an almost perfect material in terms of the environment and sustainable development. It grows twice as fast as a tree and releases 30% more oxygen into the atmosphere. </p><p></p> <p> The coasters combine modern aesthetics with local craftsmanship to sustain traditional artisan communities, while promoting bamboo as a socially and environmentally friendly material. </p><p></p> <p> A great gift idea. </p> <p> Size: 11 x 11 cm </p>",
      "bbox_min" : [
         -6.719,
         -6.377,
         0
      ],
      "count" : 1,
      "out_of_stock" : false,
      "supplier_id" : 383,
      "has_special_price" : false
   },
   {
      "parent" : "GB697BD1FZLY4U4MUZSQERNBTYSHVVZUADQWFBT4",
      "bbox_max" : [
         17.265,
         16.881,
         14.289
      ],
      "name" : "Black and Blum Fruit Loop",
      "has_lights" : false,
      "url" : "http://mydeco.com/p/black-and-blum-fruit-loop/2e578e538ca6650245a19e247ad73400e162867c/",
      "model" : "2e578e538ca6650245a19e247ad73400e162867c_01",
      "surface_height" : 15,
      "bbox_min" : [
         -17.265,
         -16.881,
         -0.294
      ],
      "description" : "This stylish hand crafted fruit bowl from Black + Blum is more than just a sculptural piece of design. If you use it for fruit, the open design allows air to circulate around the fruit preventing unpleasent, soggy and rotten fruit. The Black + Blum Fruit Loop is hand made from a single piece of free flowing chromed steel wire.",
      "level" : 2,
      "price" : 25,
      "has_special_price" : false,
      "out_of_stock" : false,
      "count" : 1,
      "supplier_id" : 6912977
   },
   {
      "name" : "Sicilia Buffet",
      "bbox_max" : [
         56.01,
         16.152,
         50.041
      ],
      "url" : "http://www.landmarkshops.com/p/157751801",
      "parent" : "GB69C2486OW7MFKG4TDLW4Q5O6HZI4SCDW3DF3RM",
      "has_special_price" : false,
      "supplier_id" : 6931016,
      "count" : 1,
      "out_of_stock" : false,
      "bbox_min" : [
         -56.01,
         -16.152,
         0
      ],
      "level" : 1,
      "model" : "127e74b25079cb4483fc183a079a2dc79bc6ac74_01",
      "surface_height" : 50,
      "sku" : "157751801"
   },
   {
      "parent" : "GB69C248YD7LYJHEP725ENSGMUZEE56XY2BQLSFM",
      "bbox_max" : [
         41,
         23.067,
         76
      ],
      "name" : "Leon Chest of Drawers",
      "url" : "http://www.landmarkshops.com/p/156958707",
      "model" : "26273fd285c3803d31479c885e983e02c57f65a1_01",
      "surface_height" : 76,
      "sku" : "156958707",
      "has_special_price" : false,
      "out_of_stock" : false,
      "count" : 3,
      "supplier_id" : 6931016,
      "bbox_min" : [
         -41,
         -23.067,
         0
      ],
      "level" : 1
   },
   {
      "url" : "http://www.biggreensmile.com/products/othentique-eggshell-laquer-bamboo-bowl-40cm/gclanbowl.aspx?productid=gclanbowl",
      "has_lights" : false,
      "bbox_max" : [
         19.986,
         19.986,
         20.051
      ],
      "name" : "O'thentique Eggshell Laquer Bamboo Bowl 40cm",
      "parent" : "GB1F297ET5K3E2JTVXVL4SRZ5MLSAUTZFOFVX7CU",
      "out_of_stock" : false,
      "count" : 1,
      "supplier_id" : 2042238,
      "has_special_price" : false,
      "price" : 49.99,
      "level" : 2,
      "bbox_min" : [
         -19.986,
         -19.986,
         0
      ],
      "description" : "This wonderful, contemporary take on traditional Vietnamese laquerware is made from spun bamboo naturally laquered and decorated with real recycled egg shells. Dimensions: 40 x 20cm O'thentique are a team of designers with one goal. Unique fusion of quality and design - The designer is Danish; his choice of medium is the traditional Vietnamese lacquer ware. Renewable resources - O'thentique use only renewable resources and recycled materials such as eggshells and bamboo. Bamboo is very a fast growing material that quickly replenishes itself. Bamboo grows twice as fast as the average tree and releases 30% more oxygen into the atmosphere. Cultural sustainability - Lacquer ware is a part of Vietnam's culture, the practice has not changed for thousands of years. O'thentique have two workshops in Vietnam which are part of a co-operative group who are paid fairly and equally. O'thentique production is small where artisans are looked after and paid well. Traditional techniques - The bamboo is split into long strips, which is then spun by hand to make bowls, platters and vases. This then undertakes the lacquer process or is painted. The leaves are then used to weave baskets. Lacquer ware practiced in Vietnam is a long and complex process that has not changed for over a thousand years. A single piece can take up to 115 days; a simple bowl will take a minimum of 50 days to finish. The lacquer is tapped from the Rhus Succedanea tree. Method - The wooden design is first sealed and gauze is applied to ensure there is no cracking. The natural lacquer is mixed with different materials including finely ground saw dust, soil and mountain rock. This is then polished underwater using a sharpening stone. This is repeated 5-6 times. The pattern of eggshells or mother of pearl is then applied by hand. This makes every piece of lacquer unique. The design has another 5 layers of polished lacquer applied. Finishes - Different types of recycled eggshells to decorate each design. Eggshell is a great natural product giving the design a cracked look. Because of it's naturally crËme to brown colour, the designs work very well in homes complemented by wood and leather furniture. The eggshell is painstakingly applied piece by piece by hand. Mother of Pearl is also used from recycled mother of pearl from sea shells to decorate many pieces. This has to be cut into shape and then it is hand applied to the design.",
      "surface_height" : 1.5,
      "model" : "9f55b26933adeabe4a39eb172052792b8b5bfc54_01"
   }
]

Room is private

HTTP403

Room not found

HTTP404

Loves

GET/rooms/:id/loved_by
Parameter Required Value
:id yes Target room ID
HTTP200
[
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1312430-1466912619.jpg",
      "bio" : "",
      "id" : 1312430,
      "role" : "regular",
      "username" : "selfless",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1353611-1465807735.jpg",
      "bio" : null,
      "role" : "regular",
      "id" : 1353611,
      "username" : "claudiairis04",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/882012-1461811108.jpg",
      "username" : "sativah",
      "id" : 882012,
      "role" : "regular",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/882012-1442572803.jpg",
      "bio" : "a 22-year old philosophy student wandering through spacetime"
   },
   {
      "role" : "regular",
      "id" : 1258928,
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1258928-1466517678.jpg",
      "username" : "sarasepideh",
      "bio" : "My name is Sepideh .\r\nI'm 14 years old .I'm Asian and I live in Iran.\r\nI'm glad that I'm here.\r\nMy cover image:tomb of Kamal-ol-molk ",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1258928-1466517722.jpg"
   },
   {
      "bio" : "I love using this program to learn, improve and put my love of design into use. While I do not have an interior design background, I very much enjoy the creative process. \r\nP.S. I put a yellow lab in every photo in memory of my Hannah, who took a part of my heart with her. ",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1191752-1456414621.JPG",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1191752-1460650351.jpg",
      "username" : "Daisy320",
      "id" : 1191752,
      "role" : "regular"
   },
   {
      "role" : "regular",
      "id" : 1183272,
      "username" : "love Tully love",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1183272-1465952213.jpg",
      "bio" : "Hi! My name is Katharyn. I'm 12 years old. I love HGTV my fav show is Fixer Upper. I looked up realistic design one day and this popped up. I love it soooooooo much. I love getting comments and ideas for my work so please comment what your ideas for the room might be.",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1183272-1454159134.jpg"
   },
   {
      "role" : "regular",
      "id" : 882115,
      "username" : "ayudewi382",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/882115-1460739286.jpg",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/882115-1460901759.jpg",
      "bio" : "I am a writer&Novelist, now on my earlier 30s and i stay at the hectic \"Big Durian\" Jakarta. "
   },
   {
      "role" : "regular",
      "id" : 537946,
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/537946-1463216984.jpg",
      "username" : "svimglim",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/537946-1424553114.jpg",
      "bio" : "Greetings from Sweden."
   },
   {
      "id" : 1018947,
      "role" : "regular",
      "username" : "maja97",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1018947-1437559759.jpg",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1018947-1436813748.jpg",
      "bio" : ""
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/821053-1451125081.gif",
      "username" : "Conchy ",
      "id" : 821053,
      "role" : "regular",
      "bio" : "Arriving at one goal is the starting point to another.\r\n\r\n                  John Dewey",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/821053-1451125025.gif"
   },
   {
      "bio" : "I'm a twenty-year old girl from Croatia. I'm not professional, but I love interior design. I spent a lot of my free time here on Roomstyler. I like the most scandinavian interior design and I'm a bit of traditionalist  in designing my rooms here. Thank you all for your likes and comments.",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/614694-1380486602.jpg",
      "username" : "martinabb",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/614694-1380399358.jpg",
      "id" : 614694,
      "role" : "regular"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/619394-1390095293.jpg",
      "bio" : "",
      "id" : 619394,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/619394-1461464018.jpg",
      "username" : "Maria Esteves de Oliveira"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "foxymirage",
      "id" : 1229253,
      "role" : "regular",
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1229253-1467080542.jpg"
   },
   {
      "role" : "regular",
      "id" : 1129261,
      "username" : "bgref",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1129261-1464790272.jpg",
      "bio" : "From America, love design, I learn to design from magazines and TV shows. Someday, when I'm old enough to get a job, I want to be an interior designer and I thought this site is a perfect place to start on that path.",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1129261-1467349107.png"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "Tuitsi",
      "id" : 144944,
      "role" : "regular",
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/IMG_1061_1.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/348404-1447202828.jpg",
      "bio" : "",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/348404-1456238552.jpg",
      "username" : "demetra019",
      "id" : 348404,
      "role" : "regular"
   },
   {
      "username" : "vagrfd",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/345404-1435004491.jpg",
      "id" : 345404,
      "role" : "regular",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/IMGP4032.JPG",
      "bio" : "Location: Greece"
   },
   {
      "id" : 1278766,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1278766-1460063194.jpg",
      "username" : "Missmarbles",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1278766-1460061456.jpg",
      "bio" : ""
   },
   {
      "bio" : "Hi! I am from Nashville, USA (originally from Russia). I am 26. I work as a software engineer.  I also have a passion for interior design. This place is Amazing!",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/899853066.jpg",
      "role" : "regular",
      "id" : 456524,
      "username" : "Violetta V",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/456524-1451786769.jpg"
   },
   {
      "bio" : "Hi everybody, my name is Ivana and I'm 19 years old. I love designing and this is absolutely amazing place. Big thanks to our team for making this site better and better everyday. Kisses and hugs to my RS friends. ♥♥♥",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/569110-1466264955.png",
      "role" : "regular",
      "id" : 569110,
      "username" : "Ivana J",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/569110-1466265636.jpg"
   },
   {
      "id" : 390170,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "ANAAPRIL",
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/m5acpe7wk3r4d7fo.jpg"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "michellitamuralles",
      "id" : 1236048,
      "role" : "regular",
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1087978-1446483897.jpg",
      "bio" : "\"Design is not just what it looks like and feels like. Design is how it works.\"\r\n\r\nSteve Jobs\r\n\r\n\r\n",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1087978-1464211467.jpg",
      "username" : "Aurora Boreas",
      "id" : 1087978,
      "role" : "regular"
   },
   {
      "whitelabel" : {
         "is_admin" : false,
         "name" : "dmLights",
         "id" : 197
      },
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1001197-1439322645.jpg",
      "id" : 1001197,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1001197-1439478083.jpg",
      "username" : "DMLights-user-1001197"
   },
   {
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg",
      "role" : "regular",
      "id" : 921598,
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "zazhome "
   },
   {
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "elivania",
      "id" : 845082,
      "role" : "regular"
   },
   {
      "username" : "marmary83",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1365047-1466754232.jpg",
      "role" : "regular",
      "id" : 1365047,
      "bio" : "I am studing interior design now and I wana be a profesional in designing softwares. because I want to implement my ideas about designing",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1365047-1466754034.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/183080-1456777830.jpg",
      "bio" : "",
      "role" : "regular",
      "id" : 183080,
      "username" : "janip ",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/183080-1392939087.jpeg"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/234230-1467223539.jpg",
      "username" : "ronron",
      "role" : "regular",
      "id" : 234230,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/234230-1467223645.jpg",
      "bio" : ""
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1088728-1445382728.jpg",
      "bio" : "Beginner designer. Hoping to get better.  Love to design and use my creativity. ",
      "username" : "megalia42",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1088728-1445382757.jpg",
      "id" : 1088728,
      "role" : "regular"
   },
   {
      "bio" : "Amo Design e amo fazer parte da comunidade Roomstyler!",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1077190-1443850194.jpg",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1077190-1465658333.jpg",
      "username" : "Alecio",
      "id" : 1077190,
      "role" : "regular"
   },
   {
      "id" : 554602,
      "role" : "regular",
      "username" : "khayeagena29",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/554602-1408723312.jpg",
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/554602-1408723328.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/632116-1434574709.jpg",
      "bio" : "",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/632116-1463084924.jpg",
      "username" : "klara992",
      "id" : 632116,
      "role" : "regular"
   },
   {
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1029343-1454092832.png",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1029343-1457792156.jpg",
      "username" : "KRdesign",
      "id" : 1029343,
      "role" : "regular"
   },
   {
      "username" : "grishka design",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1179153-1454352369.jpg",
      "role" : "regular",
      "id" : 1179153,
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1179153-1454352153.jpg"
   },
   {
      "id" : 758147,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "Ania Daliva",
      "bio" : "I love everything that is related to architecture and interior design.. Roomstyler is a perfect platform for people with imagination and the passion for interior designs.. Sky is the limit ",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/758147-1463238058.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/641198-1466712556.png",
      "bio" : "Hello, I'm Fairlight! I'm a 14 year old Canadian girl who loves design, music, animals, my friends and my family.  I love to play guitar and hope to some day become a sign language interpreter ❤ :)",
      "id" : 641198,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/641198-1466712775.png",
      "username" : "Fairlight"
   },
   {
      "username" : "MandyB84",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/802505-1410778573.jpg",
      "id" : 802505,
      "role" : "regular",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/802505-1410778179.jpg",
      "bio" : ""
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/640775-1417224494.jpg",
      "username" : "Vivi fauziaah",
      "id" : 640775,
      "role" : "regular",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/640775-1400501015.jpg",
      "bio" : "18 years old. Yogyakarta, Indonesia :)"
   },
   {
      "role" : "regular",
      "id" : 828846,
      "username" : "russ",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/828846-1466772021.jpg",
      "bio" : "Yes, I will do handstands for you, but you can't make me sophisticated.:-)",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/828846-1466737069.png"
   },
   {
      "bio" : "Agata, 20, Poland/Poznań. I love create new designs.",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg",
      "username" : "Agata_ody",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1073508-1447082930.png",
      "role" : "regular",
      "id" : 1073508
   },
   {
      "bio" : "I come from a small country - \" Taiwan \" .\r\nI grew up in the rural area, named \" Pingtung \" .\r\n\r\nHope Members will like my works.\r\n",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/861717-1461043188.jpg",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/861717-1450070947.png",
      "username" : "Ni NI",
      "id" : 861717,
      "role" : "regular"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/478389-1466811788.jpeg",
      "username" : "Mihailovikj Mimi",
      "id" : 478389,
      "role" : "regular",
      "bio" : "22 years. Student at mechanical engineering at last year.",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/478389-1462828151.jpg"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "goldina",
      "id" : 1182894,
      "role" : "regular",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1182894-1454091971.jpg",
      "bio" : ""
   },
   {
      "id" : 940632,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/940632-1446152253.jpg",
      "username" : "Ida Dzanovic",
      "bio" : "My incurable curiosity makes me richer with knowledge and new ideas. I love interior design!",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/940632-1446152071.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1370600-1467222884.png",
      "bio" : "Hi! I Am Romaysa! I Love designing rooms for fun. You Can Use My Designs IRL.",
      "username" : "Galaxy Romaysa",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1370600-1467224109.png",
      "role" : "regular",
      "id" : 1370600
   },
   {
      "bio" : "Projetos Brasileiros\r\n\r\nBrazilian designs\r\n\r\nDiseños brasileños\r\n",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1277751-1460087125.jpg",
      "whitelabel" : {
         "name" : "vivadecora",
         "id" : 201,
         "is_admin" : false
      },
      "username" : "aletamahi",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1277751-1462920378.jpg",
      "role" : "regular",
      "id" : 1277751
   },
   {
      "username" : "lydiaenderlebell",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/1192340-1464147400.JPG",
      "role" : "regular",
      "id" : 1192340,
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/1192340-1459704298.JPG"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/384273-1432599595.jpg",
      "bio" : "",
      "username" : "KarinaCastro",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/384273-1435118425.jpg",
      "role" : "regular",
      "id" : 384273
   },
   {
      "role" : "regular",
      "id" : 822017,
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/822017-1461008539.jpg",
      "username" : "franciss",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/822017-1466972503.jpg",
      "bio" : "Welcome! My name is Francesca, I'm 18 and I'm from Italy. I love creating interior design; I would like to be an interior decorator one day.\r\n"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/220149-1426985088.jpg",
      "bio" : "Brasil...",
      "username" : "sahfs",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "id" : 220149,
      "role" : "regular"
   },
   {
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg",
      "id" : 918314,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "Fretzel Gargar"
   },
   {
      "id" : 1369787,
      "role" : "regular",
      "username" : "createit",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/373565-1448500883.jpg",
      "bio" : "\r\n\r\n",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "CarmenLucia",
      "id" : 373565,
      "role" : "regular"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "milenacms28",
      "id" : 1333022,
      "role" : "regular",
      "bio" : null,
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg"
   },
   {
      "role" : "regular",
      "id" : 998543,
      "username" : "likuna485",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/998543-1466056812.jpg",
      "bio" : "",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/998543-1461146021.jpg"
   },
   {
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/141511-1440836596.jpg",
      "username" : "channing4",
      "id" : 141511,
      "role" : "regular",
      "bio" : "Very Simple, love beautiful exotic places.  In the legal field but adore design.",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/love_1.jpg"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/488520-1462550519.jpg",
      "bio" : "",
      "id" : 488520,
      "role" : "regular",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/488520-1462573582.jpg",
      "username" : "antonia_k"
   },
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/30673_1407197814960_1082868086_31127198_1987844_n.jpg",
      "bio" : "",
      "id" : 155254,
      "role" : "regular",
      "username" : "nenaa",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/backgrounds/155254-24.jpg"
   }
]

Room is private

HTTP403

Room not found

HTTP404
GET/rooms/:id/related
Parameter Required Value
:id yes Target room ID
HTTP200
[
   {
      "category" : "Living room",
      "last_updated" : "2015-08-25T12:58:37+01:00",
      "has_panorama" : false,
      "user_id" : 705999,
      "created" : "2013-12-22T04:52:04+00:00",
      "id" : 6008496,
      "hq_image_url" : null,
      "source_id" : null,
      "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/MbEosexn9aos97nr.jpg",
      "url" : "https://roomstyler.com/3dplanner/rooms/6008496/6723137",
      "name" : "one",
      "public" : true
   },
   {
      "source_id" : null,
      "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/jHF904iqe-dw510Z.jpg",
      "url" : "https://roomstyler.com/3dplanner/rooms/6008598/6723276",
      "name" : "two",
      "public" : true,
      "category" : "Bedroom",
      "last_updated" : "2015-08-25T17:48:57+01:00",
      "has_panorama" : false,
      "created" : "2013-12-22T05:49:31+00:00",
      "id" : 6008598,
      "user_id" : 705999,
      "hq_image_url" : null
   },
   {
      "source_id" : null,
      "public" : true,
      "url" : "https://roomstyler.com/3dplanner/rooms/6008662/6723380",
      "name" : "three",
      "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/ikOoiAVUVa0iue8W.jpg",
      "has_panorama" : false,
      "category" : "Kitchen",
      "last_updated" : "2015-04-02T21:51:18+01:00",
      "hq_image_url" : null,
      "user_id" : 705999,
      "created" : "2013-12-22T06:45:32+00:00",
      "id" : 6008662
   },
   {
      "hq_image_url" : null,
      "user_id" : 705999,
      "id" : 6008696,
      "created" : "2013-12-22T07:29:47+00:00",
      "has_panorama" : false,
      "category" : "Living room",
      "last_updated" : "2014-05-18T12:34:28+01:00",
      "name" : "four",
      "url" : "https://roomstyler.com/3dplanner/rooms/6008696/6814191",
      "public" : true,
      "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/bfa0OQUfrlD57UOy.jpg",
      "source_id" : null
   }
]

Room is private

HTTP403

Room not found

HTTP404

Comments

GET/rooms/:id/comments
Parameter Required Value
:id yes Target room ID
HTTP200
{
   "comments" : [
      {
         "comment" : "Fantastic job!<br>",
         "created" : "2016-07-01T05:51:23+01:00",
         "user_id" : 425289,
         "id" : 348511
      },
      {
         "comment" : "Amazing design !!<br>",
         "user_id" : 182217,
         "created" : "2016-06-30T14:35:20+01:00",
         "id" : 348399
      },
      {
         "user_id" : 705999,
         "created" : "2016-06-30T06:41:32+01:00",
         "comment" : "You'll make me happy!!<br>",
         "id" : 348363
      },
      {
         "comment" : "Formidable!",
         "created" : "2016-06-30T02:59:17+01:00",
         "user_id" : 373565,
         "id" : 348350
      },
      {
         "user_id" : 940632,
         "created" : "2016-06-29T18:58:13+01:00",
         "comment" : "The king Nari! :) Very nice! <br>",
         "id" : 348312
      },
      {
         "user_id" : 1073508,
         "created" : "2016-06-29T14:49:40+01:00",
         "comment" : "WOW!!!! It is amazing and fantastic !!!!",
         "id" : 348278
      },
      {
         "created" : "2016-06-29T14:48:20+01:00",
         "user_id" : 828846,
         "comment" : "You are on fire Nari! This is stunning!",
         "id" : 348277
      },
      {
         "created" : "2016-06-29T13:28:53+01:00",
         "user_id" : 641198,
         "comment" : "This is amazing!!! :)",
         "id" : 348265
      },
      {
         "id" : 348179,
         "user_id" : 183080,
         "created" : "2016-06-28T19:07:11+01:00",
         "comment" : "Fantastic design Nari,love all the details in here!<br>"
      },
      {
         "id" : 348166,
         "comment" : "wonderful design!",
         "created" : "2016-06-28T17:38:47+01:00",
         "user_id" : 1087978
      },
      {
         "id" : 348154,
         "comment" : "Lovely kitchen. Love that board on top of the island!<br>",
         "user_id" : 1192340,
         "created" : "2016-06-28T15:02:56+01:00"
      },
      {
         "comment" : "Thanks Bastin, demetra, vagrfd!!<br>",
         "user_id" : 705999,
         "created" : "2016-06-28T13:17:31+01:00",
         "id" : 348144
      },
      {
         "comment" : "So lovely!",
         "user_id" : 345404,
         "created" : "2016-06-28T13:05:44+01:00",
         "id" : 348141
      },
      {
         "comment" : "It's very cozy and it has beautiful details.",
         "user_id" : 348404,
         "created" : "2016-06-28T11:47:37+01:00",
         "id" : 348129
      },
      {
         "id" : 348037,
         "created" : "2016-06-27T19:51:50+01:00",
         "user_id" : 1182873,
         "comment" : "Love it! "
      },
      {
         "id" : 347909,
         "comment" : "Thank you selfless, sarasepideh and trajectory!<br>",
         "user_id" : 705999,
         "created" : "2016-06-27T16:27:31+01:00"
      },
      {
         "id" : 347908,
         "user_id" : 705999,
         "created" : "2016-06-27T16:26:54+01:00",
         "comment" : "Thanks Daisy!!<br>"
      },
      {
         "created" : "2016-06-27T16:25:36+01:00",
         "user_id" : 1312433,
         "comment" : "Very beauty!<br>",
         "id" : 347905
      },
      {
         "created" : "2016-06-27T16:09:15+01:00",
         "user_id" : 1191752,
         "comment" : "Very pretty!~ ",
         "id" : 347904
      },
      {
         "created" : "2016-06-27T16:04:51+01:00",
         "user_id" : 1258928,
         "comment" : "Stunning!Oo",
         "id" : 347902
      },
      {
         "id" : 347837,
         "user_id" : 1312430,
         "created" : "2016-06-27T07:40:13+01:00",
         "comment" : "Love this kitchen!!<br>"
      }
   ],
   "total" : 21
}

Room is private

HTTP403

Room not found

HTTP404

Add tags

Only regular authenticated users can add tags to a room. Adding tags requires a token to also be present among the other parameters.

POST/rooms/:id/tags
Parameter Required Value
:id yes Target room ID
tags no A string to declare a tag, use comma’s to add multiple tags in one request
HTTP200

Remove tags

Only regular authenticated users can remove tags from a room. Removing tags requires a token to also be present among the other parameters.

DELETE/rooms/:id/tags
Parameter Required Value
:id yes Target room ID
tags no A string to declare a tag, use comma’s to add multiple tags in one request
HTTP200

Render

regular authenticated users and whitelabel admin accounts can render a room (that they or their whitelabel own). Rendering a room requires a token to also be present among the other parameters in case of a regular authenticated user or http basic authentication in case of a whitelabel admin account.

POST/rooms/:id/render
Parameter Required Value
:id yes Target room ID
width no Default 960, between (inclusive) 1 and 1920
height no Default 540, between (inclusive) 1 and 1080
callback no A callback url (see tab callback for more info)
HTTP200

Invalid or missing width or height

HTTP422

Since it takes some time to render a room we provide a callback parameter that will receive a POST request containing information about the requested render. This means you’ll have to setup a URL that accepts a POST request if you want to know when a render is finished.

Task

POSTyour_url.com/your/post/endpoint
{
   "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/sTz3M1dDP--Qtu_d.jpg",
   "room_id" : 10000248,
   "user_id" : 972691
}

Render HD

regular authenticated users and whitelabel admin accounts can render a room (that they or their whitelabel own). Rendering a room requires a token to also be present among the other parameters in case of a regular authenticated user or http basic authentication in case of a whitelabel admin account.

POST/rooms/:id/render_hq
Parameter Required Value
:id yes Target room ID
width no Default 1920, between (inclusive) 1 and 3840
height no Default 1080, between (inclusive) 1 and 2160
callback no A callback url (see tab callback for more info)
HTTP200

Invalid or missing width or height

HTTP422

Since it takes some time to render a room we provide a callback parameter that will receive a POST request containing information about the requested render. This means you’ll have to setup a URL that accepts a POST request if you want to know when a render is finished.

Task

POSTyour_url.com/your/post/endpoint
{
   "height" : 1080,
   "status" : "success",
   "room_id" : 10000249,
   "width" : 1920,
   "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/10000249-1469527312.jpeg",
   "user_id" : 972691
}

Render Panorama

regular authenticated users and whitelabel admin accounts can render a room (that they or their whitelabel own). Rendering a room requires a token to also be present among the other parameters in case of a regular authenticated user or http basic authentication in case of a whitelabel admin account.

POST/rooms/:id/render_panorama
Parameter Required Value
:id yes Target room ID
size no Default 1080, between (inclusive) 1 and 1080
callback no A callback url (see tab callback for more info)
HTTP200

Invalid or missing size

HTTP422

Since it takes some time to render a room we provide a callback parameter that will receive a POST request containing information about the requested render. This means you’ll have to setup a URL that accepts a POST request if you want to know when a render is finished.

Task

POSTyour_url.com/your/post/endpoint
{
   "room_id" : 10000248,
   "images" : {
      "d" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/19045/left/d.jpg",
      "l" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/19045/left/l.jpg",
      "b" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/19045/left/b.jpg",
      "f" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/19045/left/f.jpg",
      "u" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/19045/left/u.jpg",
      "r" : "https://s3-eu-west-1.amazonaws.com/renders.roomstyler.com/19045/left/r.jpg"
   },
   "embed_url" : "https://roomstyler.com/panorama/19045",
   "status" : "success",
   "height" : 320,
   "width" : 320,
   "user_id" : 972691
}

Render 2D

Renders a 2D representation of a room (as seen in the editor)

regular authenticated users and whitelabel admin accounts can render a room (that they or their whitelabel own). Rendering a room requires a token to also be present among the other parameters in case of a regular authenticated user or http basic authentication in case of a whitelabel admin account.

POST/rooms/:id/render_2d
Parameter Required Value
:id yes Target room ID
width no Default 960, between (inclusive) 1 and 1920
height no Default 540, between (inclusive) 1 and 1080
callback yes A callback url (see tab callback for more info)
HTTP200

Invalid or missing width, height or callback

HTTP422

Since it takes some time to render a room we provide a callback parameter that will receive a POST request containing information about the requested render. This means you’ll have to setup a URL that accepts a POST request if you want to know when a render is finished.

Currently, we POST a request to this URL but the data you need is actually passed in the url query parameter.

This will remain for backward compatibility but we want to have this parameter in the body as well to allow more consistent request handling.

Task

POSTyour_url.com/your/post/endpoint?url=url/to/img.jpg

Users

Show

GET/users/:ids
Parameter Required Value
:ids no A single ID or a comma seperated list of IDs
HTTP200
[
   {
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/972691-1434979777.jpg",
      "role" : "admin",
      "id" : 972691,
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "username" : "Sidney Liebrand",
      "bio" : "I'm a 21 year old web developer from the Netherlands, born, raised and still living in the always magnificent Dinteloord."
   }
]

User not found

This also happens if one user in a list of user ID's isn't found. HTTP404

Create

Only whitelabel admin accounts can create a user. Creating a user through a whitelabel account requires authentication through http basic.

POST/users
Parameter Required Value
user[username] yes The display name of the user
user[email] yes The email address of the user
user[password] yes The password of the user
reset_password no Send a password reset email to the newly created users email address
HTTP201
{
   "user" : {
      "id" : 1372275,
      "email" : "hello@goodbye.com",
      "username" : "api_doc_req_sample_user"
   }
}

Invalid field(s)

HTTP422
{
   "username" : [
      "can't be blank",
      "is invalid"
   ]
}

Not logged in

You need to be logged in as whitelabel admin to create an account. HTTP403

Create login token

Only whitelabel admin accounts can create a user login token. Creating a user login token through a whitelabel account requires authentication through http basic.

GET/users/:id/token
Parameter Required Value
:id yes The user ID you want to bind the token to
HTTP201
{
   "token" : "XlHTsPjLkBIHLQDK7OBQ2w",
   "user_id" : 972691,
   "id" : 6
}

User not found

HTTP404

User does not belong to your whitelabel

HTTP403

Destroy

DELETE/users/:id
Parameter Required Value
:id yes The ID of the user to be deleted
HTTP200

User does not belong to your whitelabel

HTTP403

Login with token

POST/users/login
Parameter Required Value
token yes A generated user login token
HTTP200

Token not found or invalid

HTTP404

Token user profile

Only available when cookies are supported.

GET/users/profile
HTTP200
{
   "user" : {
      "bio" : null,
      "username" : "roomstyler_test",
      "background" : "https://d2sdvaauesfb7j.cloudfront.net/img/empty.jpeg",
      "avatar" : "https://d2sdvaauesfb7j.cloudfront.net/avatars/__default.jpg",
      "id" : 1349271
   }
}

Invalid token

HTTP403

Loved rooms

POST/users/:id/rooms_loved
Parameter Required Value
:id yes The user ID you want to bind the token to
page no A number that indicates the page you are on
per_page no The amount of results to display per page, offset by (page - 1) * per_page
HTTP200
{
   "rooms" : [{
         "name" : "Summer Breeze",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/5QAQigh6dHbC1Zd5.jpg",
         "last_updated" : "2016-06-26T09:29:08+01:00",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13552306-1463688552.jpeg",
         "public" : true,
         "id" : 13552143,
         "user_id" : 674698,
         "url" : "https://roomstyler.com/3dplanner/rooms/13552143/13552306",
         "created" : "2016-05-08T03:54:19+01:00",
         "source_id" : 13552083,
         "has_panorama" : false,
         "category" : "Living room"
      },
      {
         "user_id" : 89117,
         "id" : 13145112,
         "url" : "https://roomstyler.com/3dplanner/rooms/13145112/13145113",
         "name" : "For Alesia Ar V",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/Tzmjq8ndGh_JI7jV.jpg",
         "public" : true,
         "hq_image_url" : null,
         "last_updated" : "2016-05-11T17:16:14+01:00",
         "has_panorama" : false,
         "category" : "Living room",
         "created" : "2016-04-11T05:32:28+01:00",
         "source_id" : 13144573
      },
      {
         "url" : "https://roomstyler.com/3dplanner/rooms/13292550/13293628",
         "id" : 13292550,
         "user_id" : 762069,
         "last_updated" : "2016-06-15T17:10:02+01:00",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13293628-1461336960.jpeg",
         "public" : true,
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/iPLTLu3mpmDYxrmV.jpg",
         "name" : "bistro",
         "category" : "Other",
         "has_panorama" : false,
         "source_id" : null,
         "created" : "2016-04-20T19:54:13+01:00"
      },
      {
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13272605-1461251750.jpeg",
         "last_updated" : "2016-06-22T13:01:55+01:00",
         "public" : true,
         "name" : "French Bistro",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/0dtU9gQJBin63ep_.jpg",
         "url" : "https://roomstyler.com/3dplanner/rooms/13271937/13272605",
         "user_id" : 552097,
         "id" : 13271937,
         "source_id" : 13270865,
         "created" : "2016-04-19T15:22:08+01:00",
         "category" : "Other",
         "has_panorama" : false
      },
      {
         "user_id" : 300232,
         "id" : 13271843,
         "url" : "https://roomstyler.com/3dplanner/rooms/13271843/13272010",
         "name" : "Roberta",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/WCSZ--8PZ7waFdFd.jpg",
         "public" : true,
         "last_updated" : "2016-06-11T13:01:36+01:00",
         "hq_image_url" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/13272010-1461252686.jpeg",
         "has_panorama" : false,
         "category" : "Dining room",
         "created" : "2016-04-19T15:15:47+01:00",
         "source_id" : null
      },
      {
         "url" : "https://roomstyler.com/3dplanner/rooms/13557127/13557200",
         "user_id" : 539911,
         "id" : 13557127,
         "last_updated" : "2016-06-25T00:42:12+01:00",
         "hq_image_url" : null,
         "public" : true,
         "name" : "summer",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/3YyitxatgjptGK7V.jpg",
         "category" : "Living room",
         "has_panorama" : false,
         "source_id" : null,
         "created" : "2016-05-08T16:21:46+01:00"
      },
      {
         "url" : "https://roomstyler.com/3dplanner/rooms/11524926/11526719",
         "id" : 11524926,
         "user_id" : 89117,
         "public" : true,
         "hq_image_url" : null,
         "last_updated" : "2016-05-11T10:44:10+01:00",
         "name" : "The View I",
         "image_url" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/abvNO2ZB3CH4BccZ.jpg",
         "category" : "Living room",
         "has_panorama" : false,
         "source_id" : 11524902,
         "created" : "2015-12-23T01:35:12+00:00"
      }
   ],
   "total" : 20
}

User not found

HTTP404

Collections

POST/users/:id/collections
Parameter Required Value
:id yes The user ID
HTTP200
[
   {
      "order_nr" : null,
      "image" : null,
      "user_id" : 972691,
      "name" : "test-collection",
      "id" : 42,
      "set" : null
   },
   {
      "order_nr" : null,
      "image" : null,
      "name" : "fp-assets",
      "user_id" : 972691,
      "id" : 44,
      "set" : null
   }
]

User not found

HTTP404

Specific collection

POST/users/:id/collections/:collection_id
Parameter Required Value
:id yes The user ID
:collection_id yes The collection ID of the collection you want to fetch
HTTP200
{
   "image" : null,
   "updated_at" : "2016-04-08T09:42:45+01:00",
   "set" : null,
   "order_nr" : null,
   "created_at" : "2016-04-08T09:42:45+01:00",
   "name" : "test-collection",
   "id" : 42,
   "user_id" : 972691
}

Collection not found

HTTP404

Contests

Index

GET/contests
Parameter Required Value
page no A number that indicates the page you are on
per_page no Default 25, The amount of results to display per page, offset by (page - 1) * per_page
title no Find contests containing given string in the title
HTTP200
[{
      "start_date" : "2016-02-26T12:00:00+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/Homepolish-11125-decorating-66359019-1350x900.jpeg",
      "status" : "finished",
      "id" : 1305,
      "description" : "Design a cool and stylish bachelor pad.\r\n<br><br>\r\n<a href=\"https://www.homepolish.com/mag/our-hottest-bachelor-pads\">[INSPIRATION]</a>",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/contest_winners/1305-1457969780.jpeg",
      "end_date" : "2016-03-14T12:00:00+00:00",
      "title" : "Bachelor Pad"
   },
   {
      "title" : "Feminine Office Space",
      "end_date" : "2016-03-11T12:00:00+00:00",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/contest_winners/1304-1457704547.jpeg",
      "description" : "Design an office space with a clear feminine touch. The space could be at home or in a bigger office environment.\r\n<br><br>\r\n<a href=\"https://www.homepolish.com/mag/style-girlfriend?gallery_id=9234\">[INSPIRATION 1]</a><br>\r\n<a href=\"http://www.desiretoinspire.net/blog/2014/5/13/an-office-that-makes-you-want-to-go-to-work.html\">[INSPIRATION 2]</a>",
      "id" : 1304,
      "status" : "finished",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/Homepolish-3121-home-design-1a1d4a9c1-1350x900.jpeg",
      "start_date" : "2016-02-23T12:00:00+00:00"
   },
   {
      "end_date" : "2016-02-29T12:00:00+00:00",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/contest_winners/1303-1457364753.jpeg",
      "title" : "Traditional Bathroom",
      "start_date" : "2016-02-12T12:00:00+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/slider-35-banner5.jpg",
      "description" : "Design a bathroom using the furniture of Virtual Bathrooms. The keywords for this contest are: Country, Traditional, Contemporary.\r\n<br><br>\r\nThe top-10 winning designs will be chosen and receive 10 credits each. If you want a chance to get in the top-10 make sure you use the provided style keywords!\r\n<br><br>\r\n<a href=\"http://virtualbathrooms.roomstyler.com/\">Start designing from the Virtual Bathrooms Roomstyler</a>",
      "id" : 1303,
      "status" : "finished"
   },
   {
      "id" : 1302,
      "status" : "finished",
      "description" : "This week we introduced <a href=\"https://roomstyler.com/forum/discussions/9172\">frameless wall openings</a> in Roomstyler! Which offers a lot of possibilities, for instance to create half-high walls or decorative and creative wall openings.\r\n<br><br>\r\nIn this contest we want to challenge you to create the most fantastic designs using the new possibilities of the wall openings and the <a href=\"https://roomstyler.com/forum/discussions/9161\">wall thickness</a>!",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/basic-framing-diagram.jpg",
      "start_date" : "2016-02-05T12:00:00+00:00",
      "title" : "Wall Openings & Thickness",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/oEZC3H3PGdLwvNwY.jpg",
      "end_date" : "2016-02-25T12:00:00+00:00"
   },
   {
      "title" : "Pavilion Cafe",
      "end_date" : "2016-02-18T12:00:00+00:00",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/5AMW6zWIHTXmZtGm.jpg",
      "description" : "A Pavilion is a flexible architectural open space that invites people to come in and spend time in it. \r\n<br><br>\r\nBe inspired by the recently added chairs from Dan Form and try to use them in your design. Search for 'danform' to find all the 31 chairs available.\r\n<br><br>\r\nThe Top-10 designs in this contest will be chosen, there will be no voting in this contest.\r\n<br><br>\r\nInspiration: <a href=\"http://www.designboom.com/architecture/integrated-field-if-its-sara-cafe-nong-khae-thailand-01-26-2016/\">[1]</a>",
      "status" : "finished",
      "id" : 1301,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/Gestalten-Pavilion7.jpg",
      "start_date" : "2016-02-01T12:00:00+00:00"
   },
   {
      "end_date" : "2016-02-12T12:00:00+00:00",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/9uRScbwzJ67wz6Jq.jpg",
      "title" : "Playful Room",
      "start_date" : "2016-01-26T12:00:00+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/HAO-design-studio-the-family-playground-interiors-taiwan-designboom-05.jpg",
      "description" : "Create a room with some playful elements, so it becomes fun for children as well for their parents.\r\n<br><br>\r\n<a href=\"http://www.designboom.com/architecture/hao-design-studio-the-family-playground-interiors-taiwan-11-10-2015/\">Some inspiration</a>",
      "id" : 1300,
      "status" : "finished"
   },
   {
      "title" : "The Rooftop Garden",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/1BncUOrB7RAlhLZb.jpg",
      "end_date" : "2016-01-28T12:00:00+00:00",
      "id" : 1299,
      "status" : "finished",
      "description" : "Design a rooftop garden. And make sure you still see a part of the house with interior.\r\n<br><br>\r\n<a href=\"http://inspirationseek.com/27-roof-garden-design-ideas/\">Some inspiration</a>.",
      "start_date" : "2016-01-11T12:00:00+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/Cool-Rooftop-Garden-Design_copy.jpg"
   },
   {
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/ztc09ygdk0fMNtXA.jpg",
      "end_date" : "2016-01-20T20:00:00+00:00",
      "title" : "Parkside Living",
      "start_date" : "2016-01-05T12:00:00+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/penthousenewyork_1.jpg",
      "status" : "finished",
      "id" : 1298,
      "description" : "Design a luxurious mansion, house, apartment or penthouse in an urban city environment with a view of a park. \r\n<br><br>\r\n<a href=\"http://hiconsumption.com/2014/08/the-14-best-city-parks-in-the-world/\">Some</a> <a href=\"http://www.escapehere.com/destination/10-most-beautiful-city-parks-in-the-u-s/\">inspiration</a>."
   },
   {
      "title" : "Your Dream Place",
      "end_date" : "2016-01-14T12:00:00+00:00",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/HKGNVSci-ybXZmoq.jpg",
      "description" : "Just design the place of your dreams and enjoy!\r\n<br><br>\r\nTry to explain why you made your design and why it is a place you dream of.\r\n<br><br>\r\nHappy Holidays everyone!<br>",
      "status" : "finished",
      "id" : 1297,
      "start_date" : "2015-12-24T12:00:00+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/paradise_dream_beach_1920x1080.jpg"
   },
   {
      "id" : 1296,
      "status" : "finished",
      "description" : "Create a cozy and compact house with a big and gorgeous view!\r\nThe view can either be urban or scenic.\r\n<br><br>\r\n<a href=\"http://decordots.com/2014/11/06/airy-and-light-filled-scandinavian-apartment/\">Inspiration</a>",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/BIG_small-19_1.jpg",
      "start_date" : "2015-12-17T12:00:00+00:00",
      "title" : "Small House, Big View",
      "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/1U7aCHigYGgCmTkU.jpg",
      "end_date" : "2016-01-07T12:00:00+00:00"
   }
]

Show

GET/contests/:id
Parameter Required Value
:id yes The contest ID
HTTP200
{
   "image" : "https://d2sdvaauesfb7j.cloudfront.net/competitions/-1463663119.jpeg",
   "id" : 1317,
   "end_date" : "2016-06-06T10:00:54+01:00",
   "status" : "finished",
   "start_date" : "2016-05-20T08:00:54+01:00",
   "title" : "Big Family Kitchen",
   "winner_image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/qvKpkqHNDZJgp-_x.jpg",
   "description" : "Design a sizeable kitchen, fit for a big family.\r\n<br><br>\r\nInspiration: <a href=\"http://www.dwell.com/rooms-we-love/article/10-family-friendly-kitchens\">[1]</a>, <a href=\"http://kitchenbathtrends.com/8-ideas-for-a-family-friendly-kitchen/\">[2]</a>"
}

Contest not found

HTTP404

Entries

GET/contests/:id/contest_entries
Parameter Required Value
:id yes The contest ID
page no A number that indicates the page you are on
per_page no Default 25, The amount of results to display per page, offset by (page - 1) * per_page
order no Default id desc, use a column name followed by asc or desc to sort on different criteria
rand_seed no Will sort entries in psuedo-random order, must be a integer
HTTP200
[
   {
      "entered" : "2016-10-31T17:55:28+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/2L6QXrSPYFRhDh5j.jpg",
      "room_id" : 15242968,
      "id" : 106989,
      "name" : "127",
      "vote_count" : 0,
      "hq_image" : null
   },
   {
      "id" : 106987,
      "room_id" : 16047140,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/Zd9y3tDOJDklAyHJ.jpg",
      "entered" : "2016-10-31T17:04:09+00:00",
      "vote_count" : 0,
      "hq_image" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/16047141-1477875690.jpeg",
      "name" : "M_ORD"
   },
   {
      "id" : 106986,
      "room_id" : 16061445,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/QocEfE2UwR9NAFmt.jpg",
      "entered" : "2016-10-31T14:59:36+00:00",
      "hq_image" : "https://d2sdvaauesfb7j.cloudfront.net/room_renders/16061504-1477925828.jpeg",
      "vote_count" : 0,
      "name" : "Devided"
   },
   {
      "vote_count" : 0,
      "hq_image" : null,
      "name" : "Wood Home",
      "id" : 106985,
      "room_id" : 16060071,
      "entered" : "2016-10-31T13:58:07+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/vpF4tpyR7ze7uneD.jpg"
   },
   {
      "name" : "Amsterdam",
      "hq_image" : null,
      "vote_count" : 0,
      "entered" : "2016-10-31T13:55:55+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/ZLgZXvyES51Oky8i.jpg",
      "id" : 106984,
      "room_id" : 14808956
   },
   {
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/-HOEuvkfl4gy2j3y.jpg",
      "entered" : "2016-10-31T13:27:14+00:00",
      "room_id" : 16060177,
      "id" : 106982,
      "name" : "Spa",
      "hq_image" : null,
      "vote_count" : 0
   },
   {
      "name" : "Room Divider",
      "vote_count" : 0,
      "hq_image" : null,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/jlbMB8fcQWduEdz8.jpg",
      "entered" : "2016-10-31T13:14:19+00:00",
      "room_id" : 16060050,
      "id" : 106981
   },
   {
      "name" : "J",
      "vote_count" : 0,
      "hq_image" : null,
      "entered" : "2016-10-31T13:03:50+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/QGTlIZovfNj2-8IF.jpg",
      "id" : 106980,
      "room_id" : 16057766
   },
   {
      "room_id" : 16044944,
      "id" : 106979,
      "entered" : "2016-10-31T12:54:59+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/KjfYtJv3POQc1PQs.jpg",
      "vote_count" : 0,
      "hq_image" : null,
      "name" : "Open door"
   },
   {
      "vote_count" : 0,
      "hq_image" : null,
      "name" : "Shelving in grey",
      "id" : 106978,
      "room_id" : 16013292,
      "entered" : "2016-10-31T11:45:39+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/ee0cPtTvfW-5rPJC.jpg"
   },
   {
      "vote_count" : 0,
      "hq_image" : null,
      "name" : "concerte and glass",
      "room_id" : 15950862,
      "id" : 106977,
      "entered" : "2016-10-31T11:40:49+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/C62rTmjBX_FDPZdb.jpg"
   },
   {
      "hq_image" : null,
      "vote_count" : 0,
      "name" : "circles d",
      "room_id" : 16059032,
      "id" : 106975,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/8b__tHKGMrd3K8fQ.jpg",
      "entered" : "2016-10-31T11:31:11+00:00"
   },
   {
      "vote_count" : 0,
      "hq_image" : null,
      "name" : "my bedroom ",
      "room_id" : 16058588,
      "id" : 106974,
      "entered" : "2016-10-31T10:43:47+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/-GaNrChtPCdtsQMp.jpg"
   },
   {
      "name" : "offu",
      "vote_count" : 0,
      "hq_image" : null,
      "entered" : "2016-10-31T10:17:23+00:00",
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/tY4KyQrUfixHheP4.jpg",
      "room_id" : 12556764,
      "id" : 106971
   },
   {
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/SRN3Itw9Pjcs1CS7.jpg",
      "entered" : "2016-10-31T10:17:08+00:00",
      "room_id" : 12691888,
      "id" : 106970,
      "name" : "hm",
      "vote_count" : 0,
      "hq_image" : null
   }
]

Contest not found

HTTP404

Vote

Only regular authenticated users can vote for a contest entry. Voting requires a token to also be present among the other parameters.

POST/contests/:id/contest_entries/:entry_id/vote
Parameter Required Value
:id yes The contest ID
:entry_id yes The contest entry ID
HTTP201

User not logged in

HTTP422

Collections

Index

GET/collections
HTTP200
[
   {
      "order_nr" : null,
      "id" : 39,
      "image" : null,
      "set" : null,
      "name" : "default",
      "user_id" : 499451
   },
   {
      "set" : null,
      "user_id" : 499451,
      "name" : "secondary",
      "order_nr" : null,
      "image" : null,
      "id" : 40
   },
   {
      "user_id" : 972691,
      "name" : "test-collection",
      "set" : null,
      "image" : null,
      "id" : 42,
      "order_nr" : null
   },
   {
      "id" : 44,
      "image" : null,
      "order_nr" : null,
      "name" : "fp-assets",
      "user_id" : 972691,
      "set" : null
   },
   {
      "image" : null,
      "id" : 45,
      "order_nr" : null,
      "user_id" : 15690,
      "name" : "Cassina",
      "set" : null
   },
   {
      "set" : null,
      "name" : "Wood",
      "user_id" : 496733,
      "order_nr" : null,
      "id" : 53,
      "image" : null
   },
   {
      "set" : null,
      "user_id" : 15690,
      "name" : "bistro",
      "order_nr" : null,
      "image" : null,
      "id" : 56
   },
   {
      "order_nr" : 0,
      "image" : "https://roomstyler.com/assets/collections/fp-logo.png",
      "id" : 58,
      "set" : "floorplanner",
      "user_id" : 882593,
      "name" : "Basics"
   },
   {
      "user_id" : 1022000,
      "name" : "Condehouse (all)",
      "set" : null,
      "image" : null,
      "id" : 59,
      "order_nr" : null
   },
   {
      "order_nr" : null,
      "image" : null,
      "id" : 63,
      "set" : null,
      "user_id" : 15690,
      "name" : "Moooi"
   },
   {
      "id" : 64,
      "image" : null,
      "order_nr" : null,
      "name" : "Yoo nature",
      "user_id" : 15690,
      "set" : null
   },
   {
      "order_nr" : null,
      "id" : 65,
      "image" : null,
      "set" : null,
      "name" : "Yoo minimal",
      "user_id" : 15690
   },
   {
      "user_id" : 15690,
      "name" : "Romantic1",
      "set" : null,
      "image" : null,
      "id" : 66,
      "order_nr" : null
   },
   {
      "order_nr" : null,
      "image" : null,
      "id" : 67,
      "set" : null,
      "user_id" : 15690,
      "name" : "Kitchen romantic"
   },
   {
      "user_id" : 882593,
      "name" : "Combinado Livingroom",
      "set" : null,
      "image" : null,
      "id" : 68,
      "order_nr" : null
   },
   {
      "id" : 69,
      "image" : null,
      "order_nr" : null,
      "name" : "home by Yoo",
      "user_id" : 15690,
      "set" : null
   },
   {
      "set" : null,
      "user_id" : 15690,
      "name" : "Shades of grey",
      "order_nr" : null,
      "image" : null,
      "id" : 70
   },
   {
      "order_nr" : null,
      "id" : 71,
      "image" : null,
      "set" : null,
      "name" : "Mandy Landelijk",
      "user_id" : 882593
   },
   {
      "set" : null,
      "user_id" : 1022000,
      "name" : "Bessa Design",
      "order_nr" : null,
      "image" : null,
      "id" : 75
   },
   {
      "order_nr" : null,
      "image" : null,
      "id" : 76,
      "set" : null,
      "user_id" : 507083,
      "name" : "Structures"
   },
   {
      "set" : "floorplanner",
      "user_id" : 882593,
      "name" : "Country",
      "order_nr" : 3,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/thumbs/480/5rSL7sE8_EhF3dKy.jpg",
      "id" : 77
   },
   {
      "order_nr" : 1,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/thumbs/480/kBt6GkM8-pH26U3R.jpg",
      "id" : 78,
      "set" : "floorplanner",
      "user_id" : 882593,
      "name" : "Contemporary"
   },
   {
      "set" : "floorplanner",
      "name" : "Industrial",
      "user_id" : 882593,
      "order_nr" : 5,
      "id" : 79,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/thumbs/480/38jfA9tLqDCoChd8.jpg"
   },
   {
      "order_nr" : 4,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/thumbs/480/XViknoQ1M6AQfg8O.jpg",
      "id" : 80,
      "set" : "floorplanner",
      "user_id" : 882593,
      "name" : "Urban"
   },
   {
      "name" : "Classic",
      "user_id" : 882593,
      "set" : "floorplanner",
      "id" : 81,
      "image" : "https://d2sdvaauesfb7j.cloudfront.net/rooms/images/thumbs/480/HasoMrMRY_89PQnH.jpg",
      "order_nr" : 2
   }
]

Show

GET/collections/:id
Parameter Required Value
:id yes The collection ID
HTTP200
{
   "set" : null,
   "order_nr" : null,
   "image" : null,
   "updated_at" : "2016-04-08T09:42:45+01:00",
   "id" : 42,
   "created_at" : "2016-04-08T09:42:45+01:00",
   "user_id" : 972691,
   "name" : "test-collection"
}

Collection not found

HTTP404

Items

GET/collections/:id/items
Parameter Required Value
:id yes The collection ID
HTTP200
[
   {
      "type" : "ComponentCollectionItem",
      "updated_at" : "2016-04-18T10:51:00+01:00",
      "created_at" : "2016-04-18T10:51:00+01:00",
      "role" : null,
      "value" : "55e6e00a10ded488a216deec65cd73b73cef65a5",
      "id" : 536,
      "collection_id" : 42
   },
   {
      "type" : "ComponentCollectionItem",
      "updated_at" : "2016-04-18T10:51:06+01:00",
      "role" : null,
      "created_at" : "2016-04-18T10:51:06+01:00",
      "value" : "542bd77922b31c112cc9acb9cd21ad004b9f27de",
      "id" : 537,
      "collection_id" : 42
   },
   {
      "value" : "4b4176e772a9fd3b8024590116ce3aace7ae115e",
      "id" : 538,
      "collection_id" : 42,
      "created_at" : "2016-04-18T10:51:15+01:00",
      "role" : null,
      "type" : "ComponentCollectionItem",
      "updated_at" : "2016-04-18T10:51:15+01:00"
   },
   {
      "collection_id" : 42,
      "id" : 539,
      "value" : "c685e452f823e87a3421654c9cbedc59c699fdf0",
      "created_at" : "2016-04-18T10:51:22+01:00",
      "role" : null,
      "updated_at" : "2016-04-18T10:51:22+01:00",
      "type" : "ComponentCollectionItem"
   },
   {
      "created_at" : "2016-04-18T10:51:28+01:00",
      "role" : null,
      "value" : "5e30ac8d455ad9fd52562a0c675234e597c75066",
      "id" : 540,
      "collection_id" : 42,
      "type" : "ComponentCollectionItem",
      "updated_at" : "2016-04-18T10:51:28+01:00"
   },
   {
      "collection_id" : 42,
      "value" : "1d4bfa3bb536f5cc2054b6345503fa412e1ceb5d",
      "id" : 541,
      "role" : null,
      "created_at" : "2016-04-18T10:51:36+01:00",
      "updated_at" : "2016-04-18T10:51:36+01:00",
      "type" : "ComponentCollectionItem"
   },
   {
      "role" : null,
      "created_at" : "2016-04-18T10:51:49+01:00",
      "collection_id" : 42,
      "id" : 542,
      "value" : "3738",
      "updated_at" : "2016-04-19T12:17:39+01:00",
      "type" : "MaterialCollectionItem"
   },
   {
      "value" : "2971",
      "id" : 543,
      "collection_id" : 42,
      "role" : null,
      "created_at" : "2016-04-18T10:51:51+01:00",
      "type" : "MaterialCollectionItem",
      "updated_at" : "2016-04-19T12:18:10+01:00"
   },
   {
      "role" : null,
      "created_at" : "2016-04-18T10:52:02+01:00",
      "id" : 544,
      "value" : "2971",
      "collection_id" : 42,
      "type" : "MaterialCollectionItem",
      "updated_at" : "2016-04-19T12:18:46+01:00"
   },
   {
      "updated_at" : "2016-04-18T10:52:09+01:00",
      "type" : "ColorCollectionItem",
      "role" : null,
      "created_at" : "2016-04-18T10:52:09+01:00",
      "collection_id" : 42,
      "value" : "3F486E",
      "id" : 545
   },
   {
      "role" : null,
      "created_at" : "2016-04-18T10:52:11+01:00",
      "collection_id" : 42,
      "value" : "9A4466",
      "id" : 546,
      "updated_at" : "2016-04-18T10:52:11+01:00",
      "type" : "ColorCollectionItem"
   }
]

Collection not found

HTTP404

Materials

Show

GET/materials/:id
Parameter Required Value
:id yes The material ID
HTTP200
{
   "name" : "Zoffany Mosaic Wallpaper, Taupe, MOS06004",
   "id" : 3600,
   "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/cdb/textures/floor_and_wall/original/231537685.jpg",
   "thumbnail_url" : "https://d370hy2xlo0h5t.cloudfront.net/cdb/textures/floor_and_wall/thumbnails/231537685.jpg"
}

Material item not found

HTTP404

Components

Show

GET/components/:id
Parameter Required Value
:id yes The component ID, (A component ID is always an md5 hash)
HTTP200
{
   "name" : "Sicilia Buffet",
   "id" : "127e74b25079cb4483fc183a079a2dc79bc6ac74",
   "image_url" : "https://d370hy2xlo0h5t.cloudfront.net/cdb/renders/12/127e74b25079cb4483fc183a079a2dc79bc6ac74_01.perspective.png"
}

Component item not found

HTTP404

Categories

Index

GET/categories
HTTP200
[
   "Living room",
   "Kitchen",
   "Dining room",
   "Office",
   "Bedroom",
   "Hallway",
   "Kids room",
   "Conservatory",
   "Bathroom",
   "Other",
   "Garden",
   "Wohnzimmer",
   "Andere",
   "Esszimmer",
   "K¸che",
   "Badezimmer",
   "Schlafzimmer"
]