Get all contacts
curl --request GET \
--url https://{host}/api/contacts/all \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/contacts/all"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/contacts/all', 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://{host}/api/contacts/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <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://{host}/api/contacts/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<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://{host}/api/contacts/all")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/contacts/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"contacts": [
{
"jid": "5511999999999@s.whatsapp.net",
"name": "John Silva",
"notify": "John",
"verifiedName": "John Silva",
"businessName": ""
},
{
"jid": "5511888888888@s.whatsapp.net",
"name": "Maria Santos",
"notify": "Maria",
"verifiedName": "Maria Santos",
"businessName": ""
}
]
}
Contacts
Get All Contacts
Get complete list of all contacts from the session
GET
/
api
/
contacts
/
all
Get all contacts
curl --request GET \
--url https://{host}/api/contacts/all \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/contacts/all"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/contacts/all', 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://{host}/api/contacts/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <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://{host}/api/contacts/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<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://{host}/api/contacts/all")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/contacts/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"contacts": [
{
"jid": "5511999999999@s.whatsapp.net",
"name": "John Silva",
"notify": "John",
"verifiedName": "John Silva",
"businessName": ""
},
{
"jid": "5511888888888@s.whatsapp.net",
"name": "Maria Santos",
"notify": "Maria",
"verifiedName": "Maria Santos",
"businessName": ""
}
]
}
Description
This endpoint returns a complete list of all contacts available in the WhatsApp session, without pagination. Use this endpoint when you need all contacts at once.Query Parameters
string
required
Authenticated session ID
{
"contacts": [
{
"jid": "5511999999999@s.whatsapp.net",
"name": "John Silva",
"notify": "John",
"verifiedName": "John Silva",
"businessName": ""
},
{
"jid": "5511888888888@s.whatsapp.net",
"name": "Maria Santos",
"notify": "Maria",
"verifiedName": "Maria Santos",
"businessName": ""
}
]
}
Status Codes
200- Contacts returned successfully400- Invalid parameters401- Unauthorized session404- Session not found
Usage Example
curl -X GET "https://api.wappfy.com.br/api/contacts/all?sessionId=my-session"
const sessionId = 'my-session';
const response = await fetch(
`https://api.wappfy.com.br/api/contacts/all?sessionId=${sessionId}`
);
const data = await response.json();
console.log(data);
console.log(`Total contacts: ${data.contacts.length}`);
import requests
session_id = 'my-session'
response = requests.get(
'https://api.wappfy.com.br/api/contacts/all',
params={'sessionId': session_id}
)
data = response.json()
print(data)
print(f"Total contacts: {len(data['contacts'])}")
Authorizations
Your Wappfy API key (get it at dash.wappfy.com.br)
Query Parameters
Sort by field
Available options:
id, name Sort order - descending (Z => A, New first) or ascending (A => Z, Old first)
Available options:
desc, asc Response
200 - undefined
⌘I
