Inboxes
List and retrieve inbox details via the API
Inboxes
An inbox is a configured channel connection — such as a specific email address, WhatsApp number, or live chat widget. Each inbox has its own settings, agents, and routing rules.
Base path: /api/v1/accounts/:account_id/inboxes
List inboxes
Returns all inboxes in your account.
GET /api/v1/accounts/:account_id/inboxesResponse
{
"payload": [
{
"id": 2,
"name": "Support Chat",
"channel_type": "Channel::WebWidget",
"greeting_enabled": true,
"greeting_message": "Hi! How can we help?",
"enable_auto_assignment": true,
"timezone": "UTC",
"working_hours_enabled": false,
"csat_survey_enabled": true,
"avatar_url": "https://..."
}
]
}const response = await fetch(
'https://app.usendoto.com/api/v1/accounts/1/inboxes',
{
headers: { 'api_access_token': 'YOUR_TOKEN' },
}
);
const data = await response.json();
console.log(data.payload);import requests
response = requests.get(
'https://app.usendoto.com/api/v1/accounts/1/inboxes',
headers={'api_access_token': 'YOUR_TOKEN'},
)
print(response.json())<?php
$ch = curl_init('https://app.usendoto.com/api/v1/accounts/1/inboxes');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_access_token: YOUR_TOKEN'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);import 'package:http/http.dart' as http;
import 'dart:convert';
final response = await http.get(
Uri.parse('https://app.usendoto.com/api/v1/accounts/1/inboxes'),
headers: {'api_access_token': 'YOUR_TOKEN'},
);
print(jsonDecode(response.body));require 'net/http'
require 'json'
uri = URI('https://app.usendoto.com/api/v1/accounts/1/inboxes')
req = Net::HTTP::Get.new(uri)
req['api_access_token'] = 'YOUR_TOKEN'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)Get an inbox
Returns a single inbox by ID.
GET /api/v1/accounts/:account_id/inboxes/:idconst response = await fetch(
'https://app.usendoto.com/api/v1/accounts/1/inboxes/2',
{
headers: { 'api_access_token': 'YOUR_TOKEN' },
}
);
const inbox = await response.json();
console.log(inbox);response = requests.get(
'https://app.usendoto.com/api/v1/accounts/1/inboxes/2',
headers={'api_access_token': 'YOUR_TOKEN'},
)
print(response.json())<?php
$ch = curl_init('https://app.usendoto.com/api/v1/accounts/1/inboxes/2');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_access_token: YOUR_TOKEN'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);final response = await http.get(
Uri.parse('https://app.usendoto.com/api/v1/accounts/1/inboxes/2'),
headers: {'api_access_token': 'YOUR_TOKEN'},
);
print(jsonDecode(response.body));uri = URI('https://app.usendoto.com/api/v1/accounts/1/inboxes/2')
req = Net::HTTP::Get.new(uri)
req['api_access_token'] = 'YOUR_TOKEN'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)List assignable agents
Returns agents who can be assigned to conversations in a specific inbox.
GET /api/v1/accounts/:account_id/inboxes/:id/assignable_agentsconst response = await fetch(
'https://app.usendoto.com/api/v1/accounts/1/inboxes/2/assignable_agents',
{
headers: { 'api_access_token': 'YOUR_TOKEN' },
}
);
const agents = await response.json();
console.log(agents);response = requests.get(
'https://app.usendoto.com/api/v1/accounts/1/inboxes/2/assignable_agents',
headers={'api_access_token': 'YOUR_TOKEN'},
)
print(response.json())<?php
$ch = curl_init('https://app.usendoto.com/api/v1/accounts/1/inboxes/2/assignable_agents');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_access_token: YOUR_TOKEN'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);final response = await http.get(
Uri.parse('https://app.usendoto.com/api/v1/accounts/1/inboxes/2/assignable_agents'),
headers: {'api_access_token': 'YOUR_TOKEN'},
);
print(jsonDecode(response.body));uri = URI('https://app.usendoto.com/api/v1/accounts/1/inboxes/2/assignable_agents')
req = Net::HTTP::Get.new(uri)
req['api_access_token'] = 'YOUR_TOKEN'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)