List Instances
curl --request GET \
--url https://app.hypersender.com/api/whatsapp/v1/instances \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.hypersender.com/api/whatsapp/v1/instances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.hypersender.com/api/whatsapp/v1/instances', 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://app.hypersender.com/api/whatsapp/v1/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 => [
"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://app.hypersender.com/api/whatsapp/v1/instances"
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://app.hypersender.com/api/whatsapp/v1/instances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hypersender.com/api/whatsapp/v1/instances")
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[
{
"id": "fa3d01c4-1234-4c0d-a12f-df319b612f8c",
"name": "MyInstanceName",
"phone": "+201234567890",
"service_type": "whatsapp",
"status": "WORKING",
"access_token": "234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1",
"created_at": "2025-05-26T10:12:45"
},
{
"id": "c9a1dd76-5678-4f9d-9012-a5b78de100c3",
"name": "SecondInstance",
"phone": "+201234567891",
"service_type": "whatsapp",
"status": "SCAN_QR_CODE",
"access_token": null,
"created_at": "2025-05-25T15:30:22"
}
]List Instances
Retrieve all WhatsApp instances associated with your account with powerful filtering options.
GET
/
instances
List Instances
curl --request GET \
--url https://app.hypersender.com/api/whatsapp/v1/instances \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.hypersender.com/api/whatsapp/v1/instances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.hypersender.com/api/whatsapp/v1/instances', 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://app.hypersender.com/api/whatsapp/v1/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 => [
"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://app.hypersender.com/api/whatsapp/v1/instances"
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://app.hypersender.com/api/whatsapp/v1/instances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hypersender.com/api/whatsapp/v1/instances")
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[
{
"id": "fa3d01c4-1234-4c0d-a12f-df319b612f8c",
"name": "MyInstanceName",
"phone": "+201234567890",
"service_type": "whatsapp",
"status": "WORKING",
"access_token": "234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1",
"created_at": "2025-05-26T10:12:45"
},
{
"id": "c9a1dd76-5678-4f9d-9012-a5b78de100c3",
"name": "SecondInstance",
"phone": "+201234567891",
"service_type": "whatsapp",
"status": "SCAN_QR_CODE",
"access_token": null,
"created_at": "2025-05-25T15:30:22"
}
]List all WhatsApp instances associated with your authenticated account. Use filters to narrow down results by UUID, name, phone number, or status.
Filtering Options
You can filter the list of instances using the following query parameters:filter[uuid]- Filter by instance UUID (exact match)filter[name]- Filter by instance name (partial match)filter[phone]- Filter by phone number (exact match)filter[status]- Filter by instance status
Response Fields
Each instance in the response includes:id- Instance UUIDname- Instance namephone- Phone number in E.164 formatservice_type- Service type (whatsapp)status- Current instance statusaccess_token- Access token for the instance (null if not yet connected)created_at- Creation timestamp
Example Use Cases
- Display all instances in your application dashboard
- Filter instances by status to show only active ones
- Search for a specific instance by name or phone number
- Monitor all instances created at a specific time
Use the
filter[status] parameter with value WORKING to get only active and ready instances.Instance Status Values
STOPPED: Instance is stoppedSTARTING: Instance is starting upWORKING: Instance is running and readySCAN_QR_CODE: Waiting for QR code scanFAILED: Instance failed to startPENDING: Awaiting server assignment
Authorizations
Bearer token authentication. Example: Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1
Headers
application/json
Example:
"application/json"
Query Parameters
Filter by instance UUID
Filter by instance name (partial match)
Filter by phone number
Filter by instance status
Available options:
STOPPED, STARTING, WORKING, SCAN_QR_CODE, FAILED, PENDING Response
200 - application/json
Successful response
Instance UUID
Example:
"fa3d01c4-1234-4c0d-a12f-df319b612f8c"
Instance name
Example:
"MyInstanceName"
Phone number in E.164 format
Example:
"+201234567890"
Service type
Example:
"whatsapp"
Instance status
Available options:
STOPPED, STARTING, WORKING, SCAN_QR_CODE, FAILED, PENDING Example:
"WORKING"
Access token for the instance
Example:
"234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1"
Creation timestamp
Example:
"2025-05-26T10:12:45"