Inboxes
Get an inbox
Get an inbox available in the current account
GET
/
api
/
v1
/
inboxes
/
{id}
Get an inbox
curl --request GET \
--url https://api.evoai.app/api/v1/inboxes/{id} \
--header 'api_access_token: <api-key>'import requests
url = "https://api.evoai.app/api/v1/inboxes/{id}"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://api.evoai.app/api/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.evoai.app/api/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 => [
"api_access_token: <api-key>"
],
]);
$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.evoai.app/api/v1/inboxes/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_access_token", "<api-key>")
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.evoai.app/api/v1/inboxes/{id}")
.header("api_access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/inboxes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "01d9f573-f953-4210-a99a-cdd3bd7f37a6",
"channel_id": "d6b55c22-03c4-4778-a6d9-2d7b63e602f4",
"name": "davidson-gomes",
"channel_type": "Channel::Whatsapp",
"enable_auto_assignment": true,
"greeting_enabled": false,
"greeting_message": null,
"working_hours_enabled": false,
"out_of_office_message": null,
"timezone": "UTC",
"enable_email_collect": true,
"csat_survey_enabled": false,
"allow_messages_after_resolved": true,
"auto_assignment_config": {},
"lock_to_single_conversation": false,
"csat_config": {},
"sender_name_type": "friendly",
"business_name": null,
"display_name": "Davidson Gomes",
"default_conversation_status": null,
"avatar_url": "",
"working_hours": [
{
"day_of_week": 0,
"closed_all_day": true,
"open_hour": null,
"open_minutes": null,
"close_hour": null,
"close_minutes": null,
"open_all_day": false
},
{
"day_of_week": 1,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 2,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 3,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 4,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 5,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 6,
"closed_all_day": true,
"open_hour": null,
"open_minutes": null,
"close_hour": null,
"close_minutes": null,
"open_all_day": false
}
],
"created_at": 1769624054,
"updated_at": 1769624054,
"provider": "whatsapp_cloud"
},
"meta": {
"timestamp": "2026-02-05T16:18:53Z"
},
"message": "Inbox retrieved successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Inbox not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}Authorizations
Path Parameters
ID of the inbox
⌘I
Get an inbox
curl --request GET \
--url https://api.evoai.app/api/v1/inboxes/{id} \
--header 'api_access_token: <api-key>'import requests
url = "https://api.evoai.app/api/v1/inboxes/{id}"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://api.evoai.app/api/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.evoai.app/api/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 => [
"api_access_token: <api-key>"
],
]);
$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.evoai.app/api/v1/inboxes/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_access_token", "<api-key>")
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.evoai.app/api/v1/inboxes/{id}")
.header("api_access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/inboxes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "01d9f573-f953-4210-a99a-cdd3bd7f37a6",
"channel_id": "d6b55c22-03c4-4778-a6d9-2d7b63e602f4",
"name": "davidson-gomes",
"channel_type": "Channel::Whatsapp",
"enable_auto_assignment": true,
"greeting_enabled": false,
"greeting_message": null,
"working_hours_enabled": false,
"out_of_office_message": null,
"timezone": "UTC",
"enable_email_collect": true,
"csat_survey_enabled": false,
"allow_messages_after_resolved": true,
"auto_assignment_config": {},
"lock_to_single_conversation": false,
"csat_config": {},
"sender_name_type": "friendly",
"business_name": null,
"display_name": "Davidson Gomes",
"default_conversation_status": null,
"avatar_url": "",
"working_hours": [
{
"day_of_week": 0,
"closed_all_day": true,
"open_hour": null,
"open_minutes": null,
"close_hour": null,
"close_minutes": null,
"open_all_day": false
},
{
"day_of_week": 1,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 2,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 3,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 4,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 5,
"closed_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 17,
"close_minutes": 0,
"open_all_day": false
},
{
"day_of_week": 6,
"closed_all_day": true,
"open_hour": null,
"open_minutes": null,
"close_hour": null,
"close_minutes": null,
"open_all_day": false
}
],
"created_at": 1769624054,
"updated_at": 1769624054,
"provider": "whatsapp_cloud"
},
"meta": {
"timestamp": "2026-02-05T16:18:53Z"
},
"message": "Inbox retrieved successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Inbox not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/inboxes/{id}",
"method": "GET"
}
}