List the member's sessions across their computers
curl --request GET \
--url https://api.openworklabs.com/v1/sessions \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/sessions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/sessions', 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.openworklabs.com/v1/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.openworklabs.com/v1/sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.openworklabs.com/v1/sessions")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"ceiling": "created",
"computers": [
{
"computerId": "<string>",
"label": "<string>",
"platform": "darwin",
"online": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"supportsAccess": true,
"access": "created",
"effectiveAccess": "created",
"sessionsUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"sessions": [
{
"key": "<string>",
"computerId": "<string>",
"computerLabel": "<string>",
"workspaceId": "<string>",
"workspaceName": "<string>",
"sessionId": "<string>",
"title": "<string>",
"origin": "remote",
"reach": "reachable",
"commandId": "<string>",
"state": "starting",
"waitingFor": "permission",
"pending": {
"kind": "question",
"requestId": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"multiple": true,
"custom": true,
"questionCount": 5
},
"latestStep": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}Automations
List the member's sessions across their computers
The signed-in member’s own sessions, newest first, and the computers they are on. reach reachable: read, follow up, stop and answer it through its commandId and sessionId. connecting: a start or an attach is queued for the computer. attachable: the computer reports a session that was started on it, listed only while the organization’s ceiling and that computer’s owner both allow every session; attach first. Never lists another member’s computers or sessions. Requires the remoteSessionAccess feature.
GET
/
v1
/
sessions
List the member's sessions across their computers
curl --request GET \
--url https://api.openworklabs.com/v1/sessions \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/sessions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/sessions', 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.openworklabs.com/v1/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.openworklabs.com/v1/sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.openworklabs.com/v1/sessions")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"ceiling": "created",
"computers": [
{
"computerId": "<string>",
"label": "<string>",
"platform": "darwin",
"online": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"supportsAccess": true,
"access": "created",
"effectiveAccess": "created",
"sessionsUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"sessions": [
{
"key": "<string>",
"computerId": "<string>",
"computerLabel": "<string>",
"workspaceId": "<string>",
"workspaceName": "<string>",
"sessionId": "<string>",
"title": "<string>",
"origin": "remote",
"reach": "reachable",
"commandId": "<string>",
"state": "starting",
"waitingFor": "permission",
"pending": {
"kind": "question",
"requestId": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"multiple": true,
"custom": true,
"questionCount": 5
},
"latestStep": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Was this page helpful?