> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Current User Session Information
>
Retrieve session information for sessions owned by the authenticated user. This endpoint provides detailed information about the user's sessions on the workspace. It does not grant access to the session information of other users on the workspace.
### Changelog
| Version | Description |
| ---------------- | ------------|
|5.0.0 | Added |
## OpenAPI
````json GET /api/v1/sessions/info
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Settings"
},
"servers": [
{
"url": "https://apiexplorer.support.rocket.chat"
}
],
"tags": [
{
"name": "Settings"
},
{
"name": "Audit"
},
{
"name": "Cloud"
},
{
"name": "DNS"
},
{
"name": "E2E"
},
{
"name": "Import"
},
{
"name": "Bulk User Import"
},
{
"name": "Instances"
},
{
"name": "Federation"
},
{
"name": "Moderation"
},
{
"name": "Device Management"
},
{
"name": "Password policy"
},
{
"name": "Video Conference"
},
{
"name": "Media Calls"
}
],
"paths": {
"/api/v1/sessions/info": {
"parameters": [],
"get": {
"summary": "Get Current User Session Information",
"operationId": "get-api-v1-sessions-info",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"type": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"loginToken": {
"type": "string"
},
"ip": {
"type": "string"
},
"host": {
"type": "string"
},
"device": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"longVersion": {
"type": "string"
},
"os": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"version": {
"type": "string"
}
}
},
"userId": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"mostImportantRole": {
"type": "string"
},
"loginAt": {
"type": "string"
},
"day": {
"type": "integer"
},
"month": {
"type": "integer"
},
"year": {
"type": "integer"
},
"searchTerm": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"_updatedAt": {
"type": "string"
},
"closedAt": {
"type": "string"
},
"lastActivityAt": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"examples": {
"Success Example": {
"value": {
"_id": "646ceae9a8c3a3ba32d0e897",
"type": "session",
"sessionId": "QoYYFw2t9oKks2niG",
"instanceId": "f0313fa9-ebe6-4a84-8580-3104f6a09988",
"loginToken": "orklPYtfnjnG6mG7OMuLbOBDzs8I9myfcLl2yzv7WoU=",
"ip": "172.20.0.2",
"host": "localhost:3000",
"device": {
"type": "browser",
"name": "Chrome",
"longVersion": "113.0.0.0",
"os": {
"name": "Windows",
"version": "10"
},
"version": "113.0.0"
},
"userId": "rbAXPnMktTFbNpwtJ",
"roles": [
"user",
"admin",
"livechat-agent",
"livechat-manager"
],
"mostImportantRole": "admin",
"loginAt": "2023-05-23T16:33:45.202Z",
"day": 23,
"month": 5,
"year": 2023,
"searchTerm": "ChromebrowserWindowsQoYYFw2t9oKks2niGrbAXPnMktTFbNpwtJ",
"createdAt": "2023-05-23T16:33:45.203Z",
"_updatedAt": "2023-05-23T17:56:31.599Z",
"closedAt": "2023-05-23T17:56:31.599Z",
"lastActivityAt": "2023-05-23T17:56:31.599Z",
"success": true
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "string"
},
"errorType": {
"type": "string"
}
}
},
"examples": {
"Missing Parameter": {
"value": {
"success": false,
"errorType": "error-invalid-params",
"error": "must have required property 'sessionId'"
}
},
"Session not found": {
"value": {
"success": false,
"error": "Session not found"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/authorizationError"
}
},
"description": "\n\nRetrieve session information for sessions owned by the authenticated user. This endpoint provides detailed information about the user's sessions on the workspace. It does not grant access to the session information of other users on the workspace.\n\n### Changelog\n| Version | Description |\n| ---------------- | ------------|\n|5.0.0 | Added |",
"tags": [
"Device Management"
],
"parameters": [
{
"$ref": "#/components/parameters/X-User-Id"
},
{
"$ref": "#/components/parameters/X-Auth-Token"
},
{
"schema": {
"type": "string"
},
"example": "windows",
"in": "query",
"name": "sessionId",
"description": "The session ID.",
"required": true
}
]
}
}
},
"components": {
"responses": {
"authorizationError": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"examples": {
"Authorization Error": {
"value": {
"status": "error",
"message": "You must be logged in to do this."
}
}
}
}
}
}
},
"parameters": {
"X-User-Id": {
"name": "X-User-Id",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"example": "CkCPNctrgCDfmWLqC",
"description": "The user ID."
},
"X-Auth-Token": {
"name": "X-Auth-Token",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"example": "1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE",
"description": "The authentication token."
}
}
}
}
````
![\"Premium](\"https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg\")