Sessions v2
Get a session
Returns a single fully-normalized session.
GET
/
sessions
/
v2
/
{sessionId}
Get a session
curl --request GET \
--url https://api.readmin.app/sessions/v2/{sessionId} \
--header 'loader-id: <api-key>'import requests
url = "https://api.readmin.app/sessions/v2/{sessionId}"
headers = {"loader-id": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'loader-id': '<api-key>'}};
fetch('https://api.readmin.app/sessions/v2/{sessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.readmin.app/sessions/v2/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"loader-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.readmin.app/sessions/v2/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("loader-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.readmin.app/sessions/v2/{sessionId}")
.header("loader-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readmin.app/sessions/v2/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["loader-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}Previous
Add a server to a sessionCreates a new server on a session and returns it in normalized form.
Next
⌘I
Get a session
curl --request GET \
--url https://api.readmin.app/sessions/v2/{sessionId} \
--header 'loader-id: <api-key>'import requests
url = "https://api.readmin.app/sessions/v2/{sessionId}"
headers = {"loader-id": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'loader-id': '<api-key>'}};
fetch('https://api.readmin.app/sessions/v2/{sessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.readmin.app/sessions/v2/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"loader-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.readmin.app/sessions/v2/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("loader-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.readmin.app/sessions/v2/{sessionId}")
.header("loader-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readmin.app/sessions/v2/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["loader-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}