Get an organization's capability overrides
curl --request GET \
--url https://api.openworklabs.com/v1/admin/organizations/{organizationId}/capabilities \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/organizations/{organizationId}/capabilities"
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/admin/organizations/{organizationId}/capabilities', 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/admin/organizations/{organizationId}/capabilities",
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/admin/organizations/{organizationId}/capabilities"
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/admin/organizations/{organizationId}/capabilities")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/organizations/{organizationId}/capabilities")
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{
"capabilities": {
"organizationGrants": true,
"liveProviderSync": true,
"offlineRecovery": true,
"managedDeployments": true,
"workbotDocuments": true,
"workbotDocumentEditing": true,
"workbotWorkspaceAssistant": true,
"automationCalendar": true,
"engineV2ForceUpgrade": true,
"remoteSessionSubagents": true,
"headlessDurableTurns": true,
"headlessSessionCells": true,
"gatewayDashboard": true
},
"featureStates": {
"organizationGrants": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"liveProviderSync": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"offlineRecovery": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"managedDeployments": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"workbotDocuments": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"workbotDocumentEditing": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"workbotWorkspaceAssistant": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"automationCalendar": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"engineV2ForceUpgrade": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"remoteSessionSubagents": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"headlessDurableTurns": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"headlessSessionCells": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
}
}
}{
"error": "invalid_request",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Admin
Get an organization's capability overrides
Returns the effective value of every registry feature (capabilities) and, per feature, its source and whether /admin can change it (featureStates). The deprecated gatewayDashboard compatibility field is always true, not a mutable organization flag; deployment configuration and authorization still apply.
GET
/
v1
/
admin
/
organizations
/
{organizationId}
/
capabilities
Get an organization's capability overrides
curl --request GET \
--url https://api.openworklabs.com/v1/admin/organizations/{organizationId}/capabilities \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/organizations/{organizationId}/capabilities"
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/admin/organizations/{organizationId}/capabilities', 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/admin/organizations/{organizationId}/capabilities",
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/admin/organizations/{organizationId}/capabilities"
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/admin/organizations/{organizationId}/capabilities")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/organizations/{organizationId}/capabilities")
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{
"capabilities": {
"organizationGrants": true,
"liveProviderSync": true,
"offlineRecovery": true,
"managedDeployments": true,
"workbotDocuments": true,
"workbotDocumentEditing": true,
"workbotWorkspaceAssistant": true,
"automationCalendar": true,
"engineV2ForceUpgrade": true,
"remoteSessionSubagents": true,
"headlessDurableTurns": true,
"headlessSessionCells": true,
"gatewayDashboard": true
},
"featureStates": {
"organizationGrants": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"liveProviderSync": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"offlineRecovery": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"managedDeployments": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"workbotDocuments": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"workbotDocumentEditing": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"workbotWorkspaceAssistant": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"automationCalendar": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"engineV2ForceUpgrade": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"remoteSessionSubagents": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"headlessDurableTurns": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
},
"headlessSessionCells": {
"enabled": true,
"source": "unavailable",
"everyone": true,
"killed": true,
"lock": true,
"override": true,
"overrideApplies": true
}
}
}{
"error": "invalid_request",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"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.
Path Parameters
Response
Capability overrides returned.
Show child attributes
Show child attributes
Per feature for this organization: whether it is on and why (not part of this deployment, kill switch, operator lock, organization override, or the deployment-wide on/off state), and whether an organization override would take effect.
Show child attributes
Show child attributes
Was this page helpful?