---
id: session-get
title: "Get Session"
description: "Retrieve information about a specific session."
sidebar_label: "Get Session"
hide_title: true
hide_table_of_contents: true
api: eJzVWFtz27YS/is7yEyn5dCSmuRJb66jk3pyacZy2wfH44GIFYkIBBgsaEfV6L93FiAlSnaanKPz0ifLxOLbC/byARsRZElieiMIibSzJG5zoZAKr5ugnRVTcYXBa7xH0HbpfC35M8iFawNIoAYLvdQFdPtHIheuQR+lLpWY9sCvMYhcNNLLGgN61rkRmvEbGSqRCytr3ItfKnFsx3WFoBXaoJcaPbglhAqHej1+brVHJabBt5gLKiqspZhuRFg3ETt4bUux3d6yMDXOEhKvP59M+M+hvnlCBt/5r4DaokCiZWvMmhUWzga0gbfKpjG6iF6PPxHv3zzW7xafsIhh8ByjoJN2rR7b+JTzrdWf23+MwTZCL7XBx+4wQrd4cJIdRkvo2acvZ31G1Fgv+KBu82/Yn07uezxgyV5hgo82a7qTqtZ2ALJwzqC0j1AureIwI4EewoAmkBYiSoQspL0zrjwJs5AWjCthAFk4azkEp4F2KDvUBxmK6kTMiLFDrBydaiRD7PCokh7valRanggbkSAi7dBlLKu7wuhm4aRXJ6pIcPHrDjLqIrSK7rSVRdD3eFe0npw/QVnEgx4PEt4+ZojHuujU4CEeq6NU9aYttaWneo1USjO0NB8GVZs65KHm850kJDwgDEHbknVscxF04MYi3kWDPnSNhuMaZPhKxyla79EGiCJP9OxvdEbqKw7/p6TgpsatYQfSt5tYLdylTgDtMQ6D002NeQzJEwuvZJBiu+WVl5Ofnw4aDzKkAN1Ao6RStqHizp+mzP9x/tRIJMvvaOGvMEhtUAF67zx0+w79n/HSuw6x9/PF034S+nv00FqFnoJzKsa38z6HRcshWLaEBMFF/53XfyHo8K/y/uVXvE/UCRV4JNf6AuFBElgXYOlaq/41Pm5zUWOoHLO9sqN5oRJTMZaNHvfEcrzZUbut4F7MZ59o4KENb10hTZcbIhetN2IqqhCa6XhseI0n0/TFZDIRTOQIi9brsI5Iv6D06M9bVn9zu8034sK5lcbhl2u3Qrv7MECYczRTwIa7djGTjX6Da5En2lpEkT1xfT9789vdfDafX/72/lFczw9qF1rStmT23FHMhBWb09CDnWb2XnSENvaqKPS9WhIkBPY76hhE4CvOfW7Rr/e+xa3fqy4KQyOJUIEkkBDRYMf9UzoxB436u7R6jysH5x8uRS44MZKKF6PJaPJIcRSNbeFPXFxdX4C0in/OXbHCAAskrZDgaja/ZkRuHo1391pxc5HmLOgagf91QMGjrLUtc9A2oO9nqzNGLly6xuQR32PtAoJCWgXXwLK1RRqWOqxHH+1H++zZM7hwHuEai8o6Zp9IvHAGWfZH1DbvtYHjxpesz7KPFuAMolcG79HLEgmyrF+GpfN7w3Mw7uHMyIC2WOdQ6bI6+9xGMzqf2FrZKj3wbpRUvMF1ZENRpHYtIeA92kDApCx4aanWIaBK9sVZzZS9C3M3Rvmw2SRCWRtmWrvIOTvqHb5ie6850HNdcpQ4N6yCC1fXre1zpg9DOrk+EtH1/hOP2pZTKarcg2nbm/UjjspRvismpCAXRlNVow05XF7MmDsprZiB4JeikrbEn0YASdnbeN6VDHuEtmFZSue+6mI2TvFaSmMWsljFiFXSKtNHa2fzPgZ9ArLps3v068CEAWaGcO/rURn9AP3F8520skT2IsvgDObcpvApLhDt7I2PNvGR9w5m2ZVzdZT5nfcewV54lCEWQO2UXq7jTxbm2eOdicFOSjte7cA7V9NAwauuKC7SForA5+pTS4wMVHjEeO1Z6rJNRUU51GwIr6++lpajXsF8TQFr+BWlCRX8AO/4Tl4kPd37RFSUxKokVlRYrCiC7p4kpAFtSZdVSPansv3VPcBlgHNj4E/nVwTXrsRQoWeBn0fDWkxHTukGsy+weMRZdtRe8q4O2QQlg8yy0Uf7fHSU4GipZZYnIcsabn0UYuYutNIeuy6TZcflN2gDwwpMfr0YDfIvy/r+x21lqS2elV5qi7tDzrKUw4Nz7roep87BwcXs/g+TA+51KhIGypmoxRkTmwa/kMTEV65oOdP6nSIXRhdoCfcPB+K8kUWF8Dx2+oNx//DwMJJxdeR8Oe620vjt5cXs/Xx29nw0GVWhNnGgNI5CLe0A+DWGvpiOZ8hmT63++weubmQG/BLGjZHa8lCNhm866nPD8zSynO5VLRfT/cvWbS7SBf1GbDYLSfi7N9stf05zd3pzm4t76bVc8GhkhqSJfysxXUpDxze3oTM/XnWvYD/BNx/MnvSj5wOW5/+9NC3/J3KxwvXB89z2dpuLCqVCH01M6+dFgU0Y7HxEW5lx7eji69m12G7/BnNVKGE=
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 Session"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/api/sessions/{sessionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve information about a specific session.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"sessionId","description":"The identifier of the session.","required":true,"schema":{"type":"string"}}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Session retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the session."},"profile":{"description":"The profile information of the user.","x-tags":["members"],"type":"object","properties":{"name":{"type":"string","description":"The name of the member."},"is_admin":{"type":"boolean","description":"Indicates if the member is an admin."},"can_login":{"type":"boolean","description":"Indicates if the member can log in."},"can_connect":{"type":"boolean","description":"Indicates if the member can connect."},"can_watch":{"type":"boolean","description":"Indicates if the member can watch."},"can_host":{"type":"boolean","description":"Indicates if the member can host."},"can_share_media":{"type":"boolean","description":"Indicates if the member can share media."},"can_access_clipboard":{"type":"boolean","description":"Indicates if the member can access the clipboard."},"sends_inactive_cursor":{"type":"boolean","description":"Indicates if the member sends inactive cursor."},"can_see_inactive_cursors":{"type":"boolean","description":"Indicates if the member can see inactive cursors."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"MemberProfile"},"state":{"description":"The current state of the session.","type":"object","properties":{"is_connected":{"type":"boolean","description":"Indicates if the user is connected."},"is_watching":{"type":"boolean","description":"Indicates if the user is watching."}},"title":"SessionState"}},"title":"SessionData"}}}},"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"}}}},"404":{"description":"The specified resource was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
  
</StatusCodes>