Get an Agent's effective control manifest
curl --request GET \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls', 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.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls",
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 := "https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls"
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("https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "agent_control_manifest",
"name": "<string>",
"status": "<string>",
"profile": {
"enabled": true,
"value": {
"business_name": "<string>",
"industry": "<string>",
"business_overview": "<string>",
"role": "<string>",
"tone": "default",
"custom_tone": "<string>",
"answer_length": "default"
}
},
"rules": {
"feature_enabled": true,
"rule_set_version": 123,
"configured_count": 123,
"active_count": 123,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instruction": "<string>",
"enabled": true,
"position": 25,
"title": "<string>",
"template_key": "unsupported_topics",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"compiled_fingerprint": "<string>"
},
"knowledge": {
"enabled": true,
"summary": {},
"warnings": [
"<string>"
]
},
"handoff": {
"enabled": true,
"policy": {
"enabled": true,
"trigger_order": [
"explicit_request"
],
"triggers": {
"explicit_request": {
"enabled": true
},
"unsupported_answer": {
"enabled": true
},
"negative_feedback": {
"enabled": true
},
"keywords": {
"enabled": true,
"values": [
"<string>"
]
},
"inactivity": {
"enabled": true,
"minutes": 722
},
"custom": {
"enabled": true,
"conditions": [
{
"source": "visitor_message",
"operator": "contains",
"value": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"enabled": true
}
]
}
},
"human_profile": {
"name": "<string>",
"role": "<string>",
"bio": "<string>"
},
"contact_app_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"automations": {
"enabled": true,
"version": 123,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"trigger_type": "semantic_intent",
"trigger_config": {},
"conditions": {
"page_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"button_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"app_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stage": "any",
"handoff_state": "any"
},
"outcome_type": "suggest_reply",
"outcome_config": {},
"position": 15,
"rate_limit_seconds": 43202,
"once_per_conversation": true,
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"supported_triggers": {},
"supported_outcomes": {}
},
"presentation": {
"welcome_message": "<string>",
"suggested_replies": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"featured": true,
"operation": "message",
"kind": "<string>",
"action": {
"type": "native_chat",
"target": "<string>",
"new_tab": false
}
}
],
"footer": {
"enabled": true,
"html": "<string>",
"text": "<string>"
},
"appearance": {
"theme": "light",
"accent": "inherit",
"avatar": "initials",
"caption": "<string>",
"header_pattern": true,
"show_powered_by": true,
"source": "legacy",
"tokens": {
"primary": "<string>",
"secondary": "<string>",
"ink": "<string>",
"muted": "<string>",
"line": "<string>",
"surface": "<string>",
"panel": "<string>",
"page_start": "<string>",
"page_end": "<string>",
"assistant": "<string>"
}
},
"sources": {
"welcome_message": "agent",
"suggested_replies": "agent",
"footer": "agent",
"appearance": "legacy"
}
},
"protocol_contract": {
"version": "2026-08-05",
"states": {},
"protocols": {},
"differences": {}
},
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"instance": "<string>",
"request_id": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"instance": "<string>",
"request_id": "<string>",
"errors": {}
}Get an Agent's effective control manifest
Returns the authenticated workspace view of the Agent profile, ordered rules, knowledge readiness, handoff policy, automations, safe presentation metadata, and protocol differences. Requires content:read and remains tenant-scoped.
GET
/
workspaces
/
{workspace}
/
agents
/
{agent}
/
controls
Get an Agent's effective control manifest
curl --request GET \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls', 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.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls",
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 := "https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls"
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("https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/agents/{agent}/controls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "agent_control_manifest",
"name": "<string>",
"status": "<string>",
"profile": {
"enabled": true,
"value": {
"business_name": "<string>",
"industry": "<string>",
"business_overview": "<string>",
"role": "<string>",
"tone": "default",
"custom_tone": "<string>",
"answer_length": "default"
}
},
"rules": {
"feature_enabled": true,
"rule_set_version": 123,
"configured_count": 123,
"active_count": 123,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instruction": "<string>",
"enabled": true,
"position": 25,
"title": "<string>",
"template_key": "unsupported_topics",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"compiled_fingerprint": "<string>"
},
"knowledge": {
"enabled": true,
"summary": {},
"warnings": [
"<string>"
]
},
"handoff": {
"enabled": true,
"policy": {
"enabled": true,
"trigger_order": [
"explicit_request"
],
"triggers": {
"explicit_request": {
"enabled": true
},
"unsupported_answer": {
"enabled": true
},
"negative_feedback": {
"enabled": true
},
"keywords": {
"enabled": true,
"values": [
"<string>"
]
},
"inactivity": {
"enabled": true,
"minutes": 722
},
"custom": {
"enabled": true,
"conditions": [
{
"source": "visitor_message",
"operator": "contains",
"value": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"enabled": true
}
]
}
},
"human_profile": {
"name": "<string>",
"role": "<string>",
"bio": "<string>"
},
"contact_app_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"automations": {
"enabled": true,
"version": 123,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"trigger_type": "semantic_intent",
"trigger_config": {},
"conditions": {
"page_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"button_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"app_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stage": "any",
"handoff_state": "any"
},
"outcome_type": "suggest_reply",
"outcome_config": {},
"position": 15,
"rate_limit_seconds": 43202,
"once_per_conversation": true,
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"supported_triggers": {},
"supported_outcomes": {}
},
"presentation": {
"welcome_message": "<string>",
"suggested_replies": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"featured": true,
"operation": "message",
"kind": "<string>",
"action": {
"type": "native_chat",
"target": "<string>",
"new_tab": false
}
}
],
"footer": {
"enabled": true,
"html": "<string>",
"text": "<string>"
},
"appearance": {
"theme": "light",
"accent": "inherit",
"avatar": "initials",
"caption": "<string>",
"header_pattern": true,
"show_powered_by": true,
"source": "legacy",
"tokens": {
"primary": "<string>",
"secondary": "<string>",
"ink": "<string>",
"muted": "<string>",
"line": "<string>",
"surface": "<string>",
"panel": "<string>",
"page_start": "<string>",
"page_end": "<string>",
"assistant": "<string>"
}
},
"sources": {
"welcome_message": "agent",
"suggested_replies": "agent",
"footer": "agent",
"appearance": "legacy"
}
},
"protocol_contract": {
"version": "2026-08-05",
"states": {},
"protocols": {},
"differences": {}
},
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"instance": "<string>",
"request_id": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"instance": "<string>",
"request_id": "<string>",
"errors": {}
}Authorizations
A Contact Button scoped bearer key. Send Authorization: Bearer <token>.
Token abilities are enforced independently of workspace membership; both checks must pass.
Interactive MCP clients use registered OAuth applications, Authorization Code + PKCE,
audience-bound tokens, and explicit workspace grants. Personal Sanctum tokens remain supported.
Was this page helpful?