Get a representative Agent channel
Reads one representative provider-neutral channel of the named Agent under agents:read and channels:read. Use the organization channel list for the complete endpoint inventory. It performs no provider writes and is safe to retry.
GET
/
agents
/
{agentId}
/
channel
Get a representative Agent channel
curl --request GET \
--url https://api.getarbol.com/v1/agents/{agentId}/channel \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getarbol.com/v1/agents/{agentId}/channel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/agents/{agentId}/channel"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"address": "<string>",
"agentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"createdAt": "2026-08-29T14:30:00Z",
"displayName": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"inboundEnabled": true,
"kind": "whatsapp",
"outboundEnabled": true,
"status": "active",
"updatedAt": "2026-08-29T14:30:00Z"
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"message": "<string>",
"data": "<unknown>"
}Authorizations
userOAuthmachineOAuth
Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.
Path Parameters
Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
Maximum string length:
64Pattern:
^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Example:
"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Response
OK
Provider-neutral organization endpoint and its current Agent assignment.
Required string length:
1 - 320Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
Maximum string length:
64Pattern:
^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Example:
"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
ISO 8601 timestamp with an explicit UTC offset.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Example:
"2026-08-29T14:30:00Z"
Required string length:
1 - 160Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
Maximum string length:
64Pattern:
^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Example:
"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Channel type with an organization-managed provider endpoint.
Available options:
voice, whatsapp Example:
"whatsapp"
Customer-visible lifecycle state of an Agent channel.
Available options:
pending, active, degraded Example:
"active"
ISO 8601 timestamp with an explicit UTC offset.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Example:
"2026-08-29T14:30:00Z"
⌘I
Get a representative Agent channel
curl --request GET \
--url https://api.getarbol.com/v1/agents/{agentId}/channel \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getarbol.com/v1/agents/{agentId}/channel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/agents/{agentId}/channel"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"address": "<string>",
"agentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"createdAt": "2026-08-29T14:30:00Z",
"displayName": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"inboundEnabled": true,
"kind": "whatsapp",
"outboundEnabled": true,
"status": "active",
"updatedAt": "2026-08-29T14:30:00Z"
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"message": "<string>",
"data": "<unknown>"
}