curl --request GET \
--url https://api.openworklabs.com/v1/org/workbot-settings/teams \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/teams"
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/workbot-settings/teams', 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/workbot-settings/teams",
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/workbot-settings/teams"
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/workbot-settings/teams")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/teams")
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": {
"model": "<string>",
"name": "<string>",
"enabled": true,
"agentEnabled": true,
"agentCalendar": "everyone"
},
"teams": [
{
"teamId": "<string>",
"teamName": "<string>",
"memberCount": 4503599627370495,
"model": {
"inherit": true
},
"name": {
"inherit": true
},
"enabled": {
"inherit": true
},
"conflictingMemberCount": 4503599627370495,
"agent": {
"inherit": true,
"enabled": true,
"calendar": "everyone"
}
}
],
"canEdit": true
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Get Workbot settings per team
Returns the organization’s Workbot default model (null is the deployment’s default model), Workbot name (null when the organization set none) and whether Workbot is on for everyone, and for each team, by name, whether it uses the organization’s value or its own for each of the three. With members’ agents on (workbotProactive), organization.agentEnabled says whether they are on for everyone and each team carries agent: inherit (the team follows the organization’s policy for members’ agents) enabled (agents are on under the policy the team has now) and calendar (whether its agents read the calendar under that policy, with organization.agentCalendar the choice for everyone); the team’s own policy is read and saved at /v1/org/workbot-settings/teams/{teamId}/agent. A member on several teams whose own values for a setting differ gets the organization’s value for it; conflictingMemberCount counts them per team. Requires View OpenWork Models settings or Manage OpenWork Models.
curl --request GET \
--url https://api.openworklabs.com/v1/org/workbot-settings/teams \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/teams"
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/workbot-settings/teams', 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/workbot-settings/teams",
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/workbot-settings/teams"
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/workbot-settings/teams")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/teams")
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": {
"model": "<string>",
"name": "<string>",
"enabled": true,
"agentEnabled": true,
"agentCalendar": "everyone"
},
"teams": [
{
"teamId": "<string>",
"teamName": "<string>",
"memberCount": 4503599627370495,
"model": {
"inherit": true
},
"name": {
"inherit": true
},
"enabled": {
"inherit": true
},
"conflictingMemberCount": 4503599627370495,
"agent": {
"inherit": true,
"enabled": true,
"calendar": "everyone"
}
}
],
"canEdit": true
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Was this page helpful?