Get an organization by id (BO)
curl --request GET \
--url http://localhost:3000/bo/organizations/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/bo/organizations/v1/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/bo/organizations/v1/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/bo/organizations/v1/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:3000/bo/organizations/v1/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/bo/organizations/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/bo/organizations/v1/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "rs",
"name": "<string>",
"comment": "<string>",
"language": "fr-FR",
"timezone": "<string>",
"uploadSizeLimit": 524288,
"uploadSizeUsed": 4503599627370495,
"engagementDuration": 300,
"engagementStartAt": "2023-11-07T05:31:56Z",
"engagementEndAt": "2023-11-07T05:31:56Z",
"renewAt": "2023-11-07T05:31:56Z",
"contractType": "kare",
"onboardingStatus": "pending",
"onboardingUpdatedAt": "2023-11-07T05:31:56Z",
"accessStatus": "active",
"accessStatusUpdatedAt": "2023-11-07T05:31:56Z",
"inboundAlias": "<string>",
"createdByBoUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"addressCountry": "<string>",
"addressCity": "<string>",
"addressPostalCode": "<string>",
"addressStreet": "<string>",
"memberCount": 4503599627370495,
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true,
"canSetAccessStatus": true
},
"updatableFields": {
"name": true,
"comment": true,
"language": true,
"timezone": true,
"uploadSizeLimit": true,
"contractType": true,
"engagementDuration": true,
"engagementStartAt": true,
"onboardingStatus": true,
"address": true
},
"createdByBoUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
},
"aiProvider": "anthropic",
"aiModel": "<string>",
"aiSearchEnabled": true
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}organizations
Get an organization by id (BO)
GET
/
bo
/
organizations
/
v1
/
{id}
Get an organization by id (BO)
curl --request GET \
--url http://localhost:3000/bo/organizations/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/bo/organizations/v1/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/bo/organizations/v1/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/bo/organizations/v1/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:3000/bo/organizations/v1/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/bo/organizations/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/bo/organizations/v1/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "rs",
"name": "<string>",
"comment": "<string>",
"language": "fr-FR",
"timezone": "<string>",
"uploadSizeLimit": 524288,
"uploadSizeUsed": 4503599627370495,
"engagementDuration": 300,
"engagementStartAt": "2023-11-07T05:31:56Z",
"engagementEndAt": "2023-11-07T05:31:56Z",
"renewAt": "2023-11-07T05:31:56Z",
"contractType": "kare",
"onboardingStatus": "pending",
"onboardingUpdatedAt": "2023-11-07T05:31:56Z",
"accessStatus": "active",
"accessStatusUpdatedAt": "2023-11-07T05:31:56Z",
"inboundAlias": "<string>",
"createdByBoUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"addressCountry": "<string>",
"addressCity": "<string>",
"addressPostalCode": "<string>",
"addressStreet": "<string>",
"memberCount": 4503599627370495,
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true,
"canSetAccessStatus": true
},
"updatableFields": {
"name": true,
"comment": true,
"language": true,
"timezone": true,
"uploadSizeLimit": true,
"contractType": true,
"engagementDuration": true,
"engagementStartAt": true,
"onboardingStatus": true,
"address": true
},
"createdByBoUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
},
"aiProvider": "anthropic",
"aiModel": "<string>",
"aiSearchEnabled": true
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Query Parameters
Extend options (JSON-encoded array, e.g. ?extend=["category"]):
- "member-count": Adds
memberCount(number of users in the organization). - "actions-info": Adds
actions{ canBeUpdated, canBeDeleted }. - "updatable-fields": Adds
updatableFields(per-field editability, type-aware). - "created-by": Adds
createdByBoUser{ id, name, email } (the BO admin who created the org). - "ai-config": Adds the AI configuration { aiProvider, aiModel, aiSearchEnabled }. AI Search activation is BO-owned.
Available options:
member-count, actions-info, updatable-fields, created-by, ai-config Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
rs, ad Required string length:
1 - 100Maximum string length:
1000Available options:
fr-FR, en-US, de-DE Required string length:
1 - 100Required range:
0 <= x <= 1048576Required range:
0 <= x <= 9007199254740991Required range:
0 < x <= 600Available options:
kare, kare_pilot, kare_with_monitoring, kare_with_rus Available options:
pending, in_progress, blocked, training, ready_to_send, closed Available options:
active, inactive Pattern:
^[a-z0-9]{3,64}$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 200Required string length:
1 - 200Required string length:
1 - 20Required string length:
1 - 200Required range:
0 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
anthropic, mistral Required string length:
1 - 100