cURL
curl --request GET \
--url https://api.wabox.me/partner/instances \
--header 'Partner-Token: <api-key>'const options = {method: 'GET', headers: {'Partner-Token': '<api-key>'}};
fetch('https://api.wabox.me/partner/instances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.wabox.me/partner/instances"
headers = {"Partner-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wabox.me/partner/instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Partner-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.wabox.me/partner/instances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Partner-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b",
"name": "Loja Centro",
"token": "3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
"status": "qr",
"status_reason": null,
"connected": false,
"phone": null,
"profile_name": null,
"platform": null,
"connected_at": null,
"disconnected_at": null,
"subscription_status": "partner",
"trial_ends_at": "2026-09-15T12:00:00.000Z",
"due_at": null,
"settings": {
"auto_read_message": false,
"auto_read_status": false,
"call_reject_auto": false,
"call_reject_message": null,
"disable_enqueue_when_disconnected": false,
"delay_message_min_ms": 1000,
"delay_message_max_ms": 3000,
"proxy_url": null
},
"webhooks": {
"received_url": "https://kinbox.example/wabox/received",
"delivery_url": "https://kinbox.example/wabox/delivery",
"message_status_url": "https://kinbox.example/wabox/status",
"connected_url": "https://kinbox.example/wabox/connected",
"disconnected_url": "https://kinbox.example/wabox/disconnected",
"chat_presence_url": null,
"notify_sent_by_me": true,
"ignore_groups": false,
"ignore_private": false,
"ignore_text": false,
"ignore_image": false,
"ignore_video": false,
"ignore_audio": false,
"ignore_document": false,
"ignore_received_callback": false,
"ignore_delivery_callback": false,
"ignore_message_status_callback": false,
"ignore_connected_callback": false,
"ignore_disconnected_callback": false,
"ignore_chat_presence_callback": false,
"secret": "whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0"
},
"api_url": "https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
"created_at": "2026-09-15T12:00:00.000Z",
"updated_at": "2026-09-15T12:00:00.000Z"
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"error": {
"code": "partner_token_required",
"message": "Invalid Partner-Token"
}
}Listar instâncias
Instâncias do workspace Partner, da mais recente para a mais antiga, com token e webhooks. Filtre por status (connected / disconnected) ou q (nome, id ou número).
GET
/
partner
/
instances
cURL
curl --request GET \
--url https://api.wabox.me/partner/instances \
--header 'Partner-Token: <api-key>'const options = {method: 'GET', headers: {'Partner-Token': '<api-key>'}};
fetch('https://api.wabox.me/partner/instances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.wabox.me/partner/instances"
headers = {"Partner-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wabox.me/partner/instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Partner-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.wabox.me/partner/instances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Partner-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b",
"name": "Loja Centro",
"token": "3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
"status": "qr",
"status_reason": null,
"connected": false,
"phone": null,
"profile_name": null,
"platform": null,
"connected_at": null,
"disconnected_at": null,
"subscription_status": "partner",
"trial_ends_at": "2026-09-15T12:00:00.000Z",
"due_at": null,
"settings": {
"auto_read_message": false,
"auto_read_status": false,
"call_reject_auto": false,
"call_reject_message": null,
"disable_enqueue_when_disconnected": false,
"delay_message_min_ms": 1000,
"delay_message_max_ms": 3000,
"proxy_url": null
},
"webhooks": {
"received_url": "https://kinbox.example/wabox/received",
"delivery_url": "https://kinbox.example/wabox/delivery",
"message_status_url": "https://kinbox.example/wabox/status",
"connected_url": "https://kinbox.example/wabox/connected",
"disconnected_url": "https://kinbox.example/wabox/disconnected",
"chat_presence_url": null,
"notify_sent_by_me": true,
"ignore_groups": false,
"ignore_private": false,
"ignore_text": false,
"ignore_image": false,
"ignore_video": false,
"ignore_audio": false,
"ignore_document": false,
"ignore_received_callback": false,
"ignore_delivery_callback": false,
"ignore_message_status_callback": false,
"ignore_connected_callback": false,
"ignore_disconnected_callback": false,
"ignore_chat_presence_callback": false,
"secret": "whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0"
},
"api_url": "https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
"created_at": "2026-09-15T12:00:00.000Z",
"updated_at": "2026-09-15T12:00:00.000Z"
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"error": {
"code": "partner_token_required",
"message": "Invalid Partner-Token"
}
}Authorizations
Credencial da Partner API (workspace › Segurança › Partner API). Só nas rotas /partner/*.
Query Parameters
Available options:
connected, disconnected Response
Página de instâncias.