Skip to main content
GET
/
sessions
/
v2
/
{sessionId}
Get a session
curl --request GET \
  --url https://api.readmin.app/sessions/v2/{sessionId} \
  --header 'loader-id: <api-key>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "groupId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "durationMinutes": 123,
    "appearsAt": "2023-11-07T05:31:56Z",
    "templateId": "<string>",
    "oneOff": true,
    "game": {
      "gameId": 123,
      "placeId": 123,
      "name": "<string>",
      "thumbnail": "<string>"
    },
    "roleGroupIds": [
      "<string>"
    ],
    "servers": [
      {
        "id": "<string>",
        "nickname": "<string>",
        "linked": true,
        "linkedServerId": "<string>",
        "linkedJobId": "<string>",
        "linkedBy": "<string>",
        "claims": [
          {
            "userId": "<string>",
            "roleId": "<string>",
            "roleName": "<string>",
            "claimedBy": "<string>",
            "claimedAt": "2023-11-07T05:31:56Z",
            "claimId": "<string>"
          }
        ],
        "attendees": [
          {
            "userId": "<string>",
            "addedBy": "<string>"
          }
        ]
      }
    ],
    "counts": {
      "servers": 123,
      "claims": 123,
      "attendees": 123
    },
    "createdBy": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
loader-id
string
header
required

Path Parameters

​
sessionId
string
required

The session id.

Response

Successful operation

​
success
boolean
default:true
​
data
object