curl --request GET \
--url https://api.nuvia.ai/v1/inboxes/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nuvia.ai/v1/inboxes/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nuvia.ai/v1/inboxes/{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_URL => "https://api.nuvia.ai/v1/inboxes/{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 := "https://api.nuvia.ai/v1/inboxes/{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("https://api.nuvia.ai/v1/inboxes/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/inboxes/{id}")
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{
"name": "<string>",
"number": "<string>",
"company": "<unknown>",
"channel": "<string>",
"status": "ACTIVE",
"_id": "<string>",
"webhook_url": "<string>",
"test_mode": {
"enabled": true,
"test_numbers": [
"<string>"
]
},
"default_agent": "<unknown>",
"api_wap_config": {
"phone_number_id": "<string>",
"business_id": "<string>",
"business_token": "<string>",
"waba_id": "<string>"
},
"evolution_api_config": {
"base_url": "<string>",
"api_key": "<string>",
"instance_name": "<string>"
},
"linkedin_config": {
"account_id": "<string>",
"provider": "<string>",
"display_name": "<string>",
"profile_url": "<string>",
"public_identifier": "<string>"
},
"general_config": {
"include_operator_name_on_message": true
},
"coexistence_enabled": true,
"process_unsupported_messages": true,
"disable_inbound_ai": true,
"pdf_local_text_extraction": true,
"default_owner": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>"
}Get inbox by ID
Returns the full data of a specific inbox
curl --request GET \
--url https://api.nuvia.ai/v1/inboxes/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nuvia.ai/v1/inboxes/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nuvia.ai/v1/inboxes/{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_URL => "https://api.nuvia.ai/v1/inboxes/{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 := "https://api.nuvia.ai/v1/inboxes/{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("https://api.nuvia.ai/v1/inboxes/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/inboxes/{id}")
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{
"name": "<string>",
"number": "<string>",
"company": "<unknown>",
"channel": "<string>",
"status": "ACTIVE",
"_id": "<string>",
"webhook_url": "<string>",
"test_mode": {
"enabled": true,
"test_numbers": [
"<string>"
]
},
"default_agent": "<unknown>",
"api_wap_config": {
"phone_number_id": "<string>",
"business_id": "<string>",
"business_token": "<string>",
"waba_id": "<string>"
},
"evolution_api_config": {
"base_url": "<string>",
"api_key": "<string>",
"instance_name": "<string>"
},
"linkedin_config": {
"account_id": "<string>",
"provider": "<string>",
"display_name": "<string>",
"profile_url": "<string>",
"public_identifier": "<string>"
},
"general_config": {
"include_operator_name_on_message": true
},
"coexistence_enabled": true,
"process_unsupported_messages": true,
"disable_inbound_ai": true,
"pdf_local_text_extraction": true,
"default_owner": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>"
}Authorizations
Token JWT de autenticação
Headers
Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.
Path Parameters
Inbox ID
Response
Inbox found successfully
Inbox name
Inbox's phone number
Company that owns the inbox
Communication channel (WAP_AUTO_CLOSER, etc.)
Inbox status (ACTIVE, DELETED)
ACTIVE, DELETED Inbox ID
Webhook URL for notifications
Test mode settings
Show child attributes
Show child attributes
Default agent for new conversations
WhatsApp Business API settings (channel only)
Show child attributes
Show child attributes
Evolution API settings
Show child attributes
Show child attributes
LinkedIn settings (Unipile)
Show child attributes
Show child attributes
General inbox settings
Show child attributes
Show child attributes
Enables ingestion of smb_message_echoes (WhatsApp Coexistence).
Allows UNSUPPORTED messages from Meta to follow the agent's normal flow.
Opt-in. When true, the AI does not handle organic inbound (new conversations for human handling); the AI keeps handling campaign leads.
Opt-in for the hybrid PDF reading mode. When true, the text is extracted locally and the AI receives the TEXT instead of the image (it stays in the loop, just reorganizing it): no size limit and no vision tokens. Falls back to the vision path when local reading doesn't work (scanned PDF, non-PDF, unreadable). Default false.
ID of the default owner user for new conversations in this inbox (opt-in). Null = no default owner.
Inbox creation date
Inbox update date