---
id: sessions-get
title: "List Sessions"
description: "Retrieve a list of all active sessions."
sidebar_label: "List Sessions"
hide_title: true
hide_table_of_contents: true
api: eJzVWE1z2zgS/StdSNXULoumPcmedPM6mhlXPiZleXYOTsrVIlskIhBg0KAcrUv/fasBUqJlZyczPo0vkgngve6H/qLuVcCa1exGMTFrZ1l9ylVFXHrdBe2smqkrCl7ThgDBaA7gVoDGAJZBbwjGc4XKlevIo5y6rNRsj/gzBZUrT9w5y8Rqdq9enp3Jx0OexbAf/EBYAfdlScyr3pitEJTOBrJBzmLXGV1GttPPLAD3isuGWpRvYduRmin0HrcqVzpQy5PnbvmZSrGq82Jz0MksXU32cPDa1upYjeuGoLf6S0+gK7JBrzR50SQ0ezEKtYvQK23osZ+CMCyCtivn2+jFiNEzefH168l4NS21S/LxZv6//RZb+j4PZOdImOCjzZpvsWq1nYAsnTOE9hHKpa1EfmLQUxjQDGghokTIEu2tcfWzMEu0YFwNE8jSWSsSPA90QNmj3mEom2diRow9YuP4uUYKxB6PG/R021Kl8ZmwEQki0h4dY7rdlkZ3S4e+eiZFgotP95CRi8lWfKttqiG3Ze/Z+WeQRTwY8SDhHTQjOubi54pHdEzHKetNX2v7ZK3BqtICjebDJGuD7+mY+Xy/ExIeMIWgbS0cu1wFHaSwqHfRoA9DoRFdA4ZvVJyy955sgLjlUb36o8qiecw4+ktBIUVNSsMeZCw3MVukSj0DdMR4KM7QThZRkicWXmNAtZO/XP3r7MenVfP0pScO8VN74sSJfWik9Kf281ca0zdkbokZ6++o4a8poDZUAXnvPAznHgowl6V3A+Lo56un/WTyG/LQ24o8B+eqKPDgfQ7LXiRY9UwMwUX/ndf/JdDhb+P9LlcthcbJaFLHkaTD0KiZOsVOn+7HHylOooV03mOl3roSzaCVylXvjZqpJoRudnpqZE1K9ezV2dmZ2n0SoLL3Omwj0r8JPfnzXihvPu3ye3Xh3FrT9Mm1W5PdP5ggLETBJNL01GHO6fQbioOOmFnGLSof5gH1fv7m19vFfLG4/PX9Iy3PH8Qy9KxtDThWBkhYMVunHuyZxXvRLBooyRs3fS9LgoQgfkeOiQLfcO5LT3578C0e/V66uBk6ZKYKkAEhokGHHlsKcQiSsmRXLvIPofSe1g7OP1yqXElgJIpXxVlx9og4bo1p8jstr64vAG0lXxeuXFOAJbGuiOFqvrgWREmmzruNriTZ0JwE3RLIvw44eMJW2zoHbQP5sdk4Y3Dp0pydR3xPrQsEFfE6uA5WvS1T99BhW3y0H+2LFy/gwnmCayob62QcI5aFE8iy/0S2xcgGTgpBsj7LPlqAE4heGdqQx5oYsmxchpXzB8NzMO7uxGAgW25zaHTdnHzpoxmDT2It9pWeeFckije0jeNB3NK6ngloQzYwyJQSPFpudQhUJfti85IZdpB56Cty2WISE7ZGRo+9cs4Wo8NXYu+1CL3QtagksWEruHBt29sxZkYZ0s2NSkTXx0fSe3oJpUh5ANN2NOsfVNRFvk8m4oBLo7lpyYYcLi/mMkxUupKWTF/LBm1N/ywAEtnbeN8NhgNC38leTve+HjQ7TXqt0JglluuoWIO2MqNae5sPGowBKKbPN+S3QToozA3TwdejNPoBhtYJ79BiTeJFlsEJLKRM0VO9Mdo5Gh9tkisfHcyyK+fauOc3OXsEe+EJQ0yA1lV6tY1fZbP0G+9MFDuRDoOmA+9cyxOC10NSXKQjHIHPq889CzJw6Ynie8BK131KKs6hFUNkff2tsCxGgsWWA7XwC6EJDfwA7+TltUw8w5tzJErbmrStbKhccwTdvzOjAW1Z101I9qe0/cXdwWWAc2Pgd+fXDNeuptCQlw0/FtNcTFfOaaQ/JFi84iw7Ki/5kIdiQoUBs6z4aF8WRwFOlnuZehCyrJPSxyFG7lJX2tNQZbLsOP0mZWCagcmvV8Uk/rJsrH9SVlba0kntUVvaX3KWpRie3PNQ9SR0HlxcjO6fZCCQWlfFIYFzGVxij4lFQ35KiIFfubKXSBtPqlwZXZJlOrxJq/MOy4bgZaz0D9r93d1dgXG1cL4+HY7y6dvLi/n7xfzkZXFWNKE1saF0jkOLdgL8Vn5IWRxmjgdd5P4wUP2JH1+GbhnoazjtDGor/TTafD9MOjfSSuOAc/ipJ72f3qj7+yUy/ebNbiePU5ed3XzK1Qa9xqU0QhlSVENYkY8jzZq2olFZUifj1AZNn/r10Qgok8x+9Pp5fq12u/8B7w9v+w==
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={"List Sessions"}
>
</Heading>

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



Retrieve a list of all active sessions.

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

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Sessions retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"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"}}}}}}
>
  
</StatusCodes>


      