curl --request GET \
--url https://api.openworklabs.com/v1/org \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org"
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', 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",
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"
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")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org")
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{
"organization": {
"owner": {
"memberId": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"image": "<string>"
}
},
"currentMember": {
"permissions": [
"organization.update"
]
},
"currentMemberTeams": [
{}
],
"capabilities": {
"auditLogs": true,
"gatewayDashboard": true
},
"features": {
"engineV2ForceUpgrade": true
},
"canManageDeploymentServices": true,
"deploymentCapabilities": {
"version": 1,
"aiGateway": true,
"serviceReadiness": {
"version": 2,
"checkedAt": "2023-11-07T05:31:56Z",
"checking": true,
"services": [
{
"id": "database",
"configured": true,
"state": "ready",
"reason": "not_checked",
"dependencies": [
"database"
],
"checkedAt": "2023-11-07T05:31:56Z",
"lastSuccessAt": "2023-11-07T05:31:56Z",
"stale": true
}
]
}
},
"entitlements": {
"sso": true,
"desktopPolicies": true,
"orgControls": true,
"analytics": true,
"auditLogs": true,
"scim": true
}
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}Get active organization
Returns the active organization from the current session, including its owner, the current member record, and their team memberships.
curl --request GET \
--url https://api.openworklabs.com/v1/org \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org"
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', 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",
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"
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")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org")
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{
"organization": {
"owner": {
"memberId": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"image": "<string>"
}
},
"currentMember": {
"permissions": [
"organization.update"
]
},
"currentMemberTeams": [
{}
],
"capabilities": {
"auditLogs": true,
"gatewayDashboard": true
},
"features": {
"engineV2ForceUpgrade": true
},
"canManageDeploymentServices": true,
"deploymentCapabilities": {
"version": 1,
"aiGateway": true,
"serviceReadiness": {
"version": 2,
"checkedAt": "2023-11-07T05:31:56Z",
"checking": true,
"services": [
{
"id": "database",
"configured": true,
"state": "ready",
"reason": "not_checked",
"dependencies": [
"database"
],
"checkedAt": "2023-11-07T05:31:56Z",
"lastSuccessAt": "2023-11-07T05:31:56Z",
"stale": true
}
]
}
},
"entitlements": {
"sso": true,
"desktopPolicies": true,
"orgControls": true,
"analytics": true,
"auditLogs": true,
"scim": true
}
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Response
Organization context returned successfully.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Effective on/off for every OpenWork feature in this organization, plus fixed deprecated client compatibility values. Treat a missing key as off.
Show child attributes
Show child attributes
Whether this caller may open installation diagnostics: a self-hosted installation administrator (local allowlist), signed in or using an API key they own. Organization ownership and permissions never grant it. False on hosted deployments and when the lookup fails.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?