---
agentTools:
  projectIndex: https://keytocheck.readme.io/llms.txt
---

# /locations/{location}/rooms/{room}

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "KeyToCheck",
    "description": "KeyToCheck API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.keytocheck.com/api",
      "description": "Main (production) server"
    },
    {
      "url": "https://apisandbox.keytocheck.com/api",
      "description": "Sandbox server for testing"
    }
  ],
  "paths": {
    "/locations/{location}/rooms/{room}": {
      "get": {
        "tags": [
          "LocationRoom"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/LocationPathParameter"
          },
          {
            "$ref": "#/components/parameters/RoomPathParameter"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/LocationRoomResponse"
          },
          "401": {
            "$ref": "#/components/responses/BadTokenErrorResponse"
          },
          "404": {
            "$ref": "#/components/responses/LocationRoomNotFoundErrorResponse"
          },
          "500": {
            "$ref": "#/components/responses/ErrorResponse"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "LocationRoom": {
        "type": "object",
        "required": [
          "id",
          "name",
          "metadata"
        ],
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "metadata": {
            "type": "object",
            "nullable": false,
            "additionalProperties": true
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "parameters": {
      "LocationPathParameter": {
        "in": "path",
        "name": "location",
        "required": true,
        "schema": {
          "type": "string",
          "nullable": false
        }
      },
      "RoomPathParameter": {
        "in": "path",
        "name": "room",
        "required": true,
        "schema": {
          "type": "string",
          "nullable": false
        }
      }
    },
    "responses": {
      "ErrorResponse": {
        "description": "",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "success",
                "error",
                "message"
              ],
              "properties": {
                "success": {
                  "type": "boolean",
                  "default": false,
                  "nullable": false
                },
                "error": {
                  "type": "integer",
                  "default": 500,
                  "nullable": false
                },
                "message": {
                  "type": "string",
                  "nullable": false
                }
              }
            }
          }
        }
      },
      "BadTokenErrorResponse": {
        "description": "Access token is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "success",
                "error",
                "message"
              ],
              "properties": {
                "success": {
                  "type": "boolean",
                  "default": false,
                  "nullable": false
                },
                "error": {
                  "type": "integer",
                  "default": 401,
                  "nullable": false
                },
                "message": {
                  "type": "string",
                  "default": "error.bad-token",
                  "nullable": false
                }
              }
            }
          }
        }
      },
      "LocationRoomNotFoundErrorResponse": {
        "description": "",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "success",
                "error",
                "message"
              ],
              "properties": {
                "success": {
                  "type": "boolean",
                  "default": false,
                  "nullable": false
                },
                "error": {
                  "type": "integer",
                  "default": 404,
                  "nullable": false
                },
                "message": {
                  "type": "string",
                  "nullable": false,
                  "enum": [
                    "error.location-not-found",
                    "error.location-room-not-found"
                  ]
                }
              }
            }
          }
        }
      },
      "LocationRoomResponse": {
        "description": "",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "success",
                "data"
              ],
              "properties": {
                "success": {
                  "type": "boolean",
                  "default": true,
                  "nullable": false
                },
                "data": {
                  "$ref": "#/components/schemas/LocationRoom"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 114,
      "2": 232,
      "3": 241,
      "4": 248,
      "5": 91,
      "6": 51,
      "7": 0,
      "8": 22,
      "9": 97,
      "10": 214,
      "11": 14
    }
  }
}
```