curl --request GET \
--url https://api.openworklabs.com/v1/org/computers \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org/computers"
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/org/computers', 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/org/computers",
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/org/computers"
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/org/computers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/computers")
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{
"devices": [
{
"id": "<string>",
"kind": "desktop",
"provider": "openwork_desktop",
"source": "desktop_app",
"platform": "darwin",
"label": "<string>",
"availability": "online",
"state": "ready",
"statusDetail": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"appVersion": "<string>",
"computerId": "<string>",
"workbotChat": "<string>",
"organization": {
"id": "<string>",
"name": "<string>"
},
"owner": {
"memberId": "<string>",
"name": "<string>",
"email": "<string>",
"former": false
},
"shared": true,
"externalId": "<string>",
"removedAt": "2023-11-07T05:31:56Z",
"recentProblems": 4503599627370495,
"lastEvent": {
"id": "<string>",
"type": "registered",
"level": "info",
"message": "<string>",
"actor": "member",
"createdAt": "2023-11-07T05:31:56Z",
"data": {},
"actorId": "<string>"
},
"workingSince": "2023-11-07T05:31:56Z",
"canRemove": false,
"disconnectedAt": "2023-11-07T05:31:56Z",
"canDisconnect": false,
"remoteAccess": {
"effective": "off",
"chosen": true,
"reason": "organization"
}
}
],
"total": 4503599627370495,
"page": 123,
"pageSize": 123,
"instances": [
{
"id": "<string>",
"name": "<string>",
"destination": "local",
"status": "provisioning",
"owner": {
"memberId": "<string>",
"name": "<string>",
"email": "<string>"
},
"version": "<string>",
"provider": "<string>",
"region": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"instancesTotal": 4503599627370495,
"instancePage": 123,
"instancePageSize": 123,
"online": 4503599627370495,
"staleHidden": 0
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}List team computers
Read-only computer inventory for the current organization, including all members and shared registered devices. Includes owners, type, provider, versions, state, last contact and reported readiness. Desktops nobody has heard from for 30 days are left out and counted in staleHidden unless stale=include; a disconnected desktop stays listed for 30 days after it was disconnected. total and paging count what is listed, and online how many of those answered in the last ten minutes. Retained runner-only registrations are imported within this organization, even when stale. Registrations already pruned by runner retention cannot be recovered. canDisconnect and canRemove say what the caller may do with computers.disconnect. remoteAccess on a desktop that takes tasks from other devices says what they may do there under its owner’s own policy, whether the owner chose it, and why when something else decides it. Devices and registered local/cloud worker instances are independently paged, 50 per page. search applies to both; kind/provider/availability/page filter devices; instanceDestination/instanceStatus/instanceProvider/instancePage filter registered instances. Never deployment-wide totals, credentials, files, screen content or conversation titles. Requires Devices and computers.view; does not grant control of computers.
curl --request GET \
--url https://api.openworklabs.com/v1/org/computers \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org/computers"
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/org/computers', 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/org/computers",
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/org/computers"
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/org/computers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/computers")
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{
"devices": [
{
"id": "<string>",
"kind": "desktop",
"provider": "openwork_desktop",
"source": "desktop_app",
"platform": "darwin",
"label": "<string>",
"availability": "online",
"state": "ready",
"statusDetail": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"appVersion": "<string>",
"computerId": "<string>",
"workbotChat": "<string>",
"organization": {
"id": "<string>",
"name": "<string>"
},
"owner": {
"memberId": "<string>",
"name": "<string>",
"email": "<string>",
"former": false
},
"shared": true,
"externalId": "<string>",
"removedAt": "2023-11-07T05:31:56Z",
"recentProblems": 4503599627370495,
"lastEvent": {
"id": "<string>",
"type": "registered",
"level": "info",
"message": "<string>",
"actor": "member",
"createdAt": "2023-11-07T05:31:56Z",
"data": {},
"actorId": "<string>"
},
"workingSince": "2023-11-07T05:31:56Z",
"canRemove": false,
"disconnectedAt": "2023-11-07T05:31:56Z",
"canDisconnect": false,
"remoteAccess": {
"effective": "off",
"chosen": true,
"reason": "organization"
}
}
],
"total": 4503599627370495,
"page": 123,
"pageSize": 123,
"instances": [
{
"id": "<string>",
"name": "<string>",
"destination": "local",
"status": "provisioning",
"owner": {
"memberId": "<string>",
"name": "<string>",
"email": "<string>"
},
"version": "<string>",
"provider": "<string>",
"region": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"instancesTotal": 4503599627370495,
"instancePage": 123,
"instancePageSize": 123,
"online": 4503599627370495,
"staleHidden": 0
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Query Parameters
Response
Team computers returned.
Was this page helpful?