---
id: settings-get
title: "Get Room Settings"
description: "Retrieve the current settings of the room."
sidebar_label: "Get Room Settings"
hide_title: true
hide_table_of_contents: true
api: eJzVV99v2zYQ/lcOLFBsgiy76Z78lqVeG7TNithdH5IgoKWzxJoiVR7l1DP8vw9HSrbitkAz7GVPtqXjdz/43d3nnfCyJDG9Ec7aekTovTIlibtUFEi5U41X1oipuEbvFG4QfIWQt86h8dCbg12F54yRiVTYBp3kg5eFmIre6jV6kQqH1FhDSGK6E2eTCX+cuLK2PkK7znEB1OY5Eq1arbfsJbfGo/EMIJtGqzy4HH8mRtkJyiusJX/z2wbFVNjlZ8w5hMZxgF7FGBqnNtLjfW0LHFgvrdUojTgtxKUp2BMSqGPSoAiUgQ4KGCoT+1Rom6+xuOdIndX0r+F7AJAOIYIGfFVz3srfV5a4XE910J+H7jzngUYudY9vZO7VBu/z1pF1T06gPw/d+RA/VfbBBPgaXa5Wrb53mFtj+Hae6KBHgAPCaQqNbktl6Hs8kEWhGFTqDwNGeNfiqc/zgyVEvAM/M7Hfp8Irrxl63vfPfs+Pf5u8+JbeC75U/NIi+fCpHBK0hA5k6ys0viPyf0jxGolkOWQ3ecd0Oc3zFXqpNBaAzlkH3bnHOc741fsOsc/z5ffzJHQbdNCaAh15a4tI6Zh9CsuWS7BqCQm8Dflbp/5GUP5/k32gsa8sT7oyTLhG+kpMxVg2aszdOz5M1VTEgvDAPS3XO5tL3RVMpKJ1WkxF5X0zHY81v+MWnb6cTCZif8dAeeuU3wak31E6dOct+72526c7cWHtWuHwycKu0RweDBDmXMZYqeGpQ7Fko97iVvAwEFORBxORCiNrfns1e/vn/Xw2n1/+efVNQc8fERpa4hEjgZCIf0es0KXDDA6eOXuuWQiQJ0Iw+lkvERI85x18DCrwg+S+tOi2x9zC0Z91F4yhkURYgCSQENCgkU7W6NFFHimzssF/x6crXFs4/3ApUsHEiC5eZpNs8o3jYBp65RMurxcXIE3BX+e8DzwskVSBBNez+YIRuaMaZzeq4I6TeuRVjcA/LZB3KGtlyhSU8ej6KW21lksbd3ca8B3W1iMUSGtvG1i1Jo+DUPltdmtuzbNnz+DCOoQF5pWx2pYKiV+MIEn+Ct7mvTewPA1i9ElyawBGELLSuEEnSyRIkv41rKw7Bp6Ctg8jLT2afJtCpcpq9KUNYXQ5cbSyLdQguyy6eIvbpZWuCCa1bQkBN2h8XEfeSUO18h6LGB+PKJI19mXuFgtfNodEKGuNRMfKWZP1CV9zvAsu9FyVXCXmhingwtZ1a3rO9GWIN9dXIqTeP+I11jKVgssjmDJ9WL9gVmbpoZmQvFxqRVWNxqdweTGDXJpCFSxI8GteSVPirxlAdPYu3Hcl/RGhbdiW4r2vu5qNY71WUuulzNehYpU0he6rdYj5WIOegBz6bINu6ysOfaYJj7metNFzmHdhvJdGlshZJAmMYM5jCr+3IEOcffAhJr7yPsEkCTqSbT7y2RPYC4fShwaobaFW2/CVjTupFYodnQbVyd3Ew5wGDl51TXHRqbMAfF58bqOWotwh8pQzK1W2sakohZoD4ffrH9Ey6x3Mt+Sxhjcota/gObxnLZxHP50gD46iWRXN8grzNQXQgw6XGpQhVVY+xh/b9o19gEsP51rDJ+vWBAtboq/QscGLbNiL8coJaiyUPDZYuOIkORkvadeHHEIhvUyS7NacZScER0MtSx8JSdLw6CMfmLtUhXLYTZkkOW2/wRgYdmDM62U24F+S9POPx8pKGRyVTiqDh0tOksjhwT13U68T3ceLC+z+g1UBz7oiKAVKWb2EHROGBv8zCcQvbN4y0/qTIhVa5WgoiJBuu5w3Mq8QzsKkf7TuHx4eMhneZtaV4+4ojd9dXsyu5rPRWTbJKl/rsFAaS76WZgD8Gj0E7s+PuuPRJtkdldXT/td1S9PjVz9utFSG12oIfdepnhveqPwvz9o6yJ3j/0nWL2yw2y0l4Uen93t+HHfu9OYuFRvpFAv3KFlEhbJAFwTOGrdcsTzHhhXWRuo2bu8TVci65qDGXs8WYr//B5qsMb8=
sidebar_class_name: "get api-method"
info_path: docs/v3/api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Room Settings"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/api/room/settings"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve the current settings of the room.

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Room settings retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"private_mode":{"type":"boolean","description":"Indicates if the room is in private mode."},"locked_controls":{"type":"boolean","description":"Indicates if the room controls are locked."},"implicit_hosting":{"type":"boolean","description":"Indicates if implicit hosting is enabled."},"inactive_cursors":{"type":"boolean","description":"Indicates if inactive cursors are shown."},"merciful_reconnect":{"type":"boolean","description":"Indicates if merciful reconnect is enabled."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"Settings"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
  
</StatusCodes>


      