Skip to main content
GET
/
api
/
contacts
/
all
Get all contacts
curl --request GET \
  --url https://{host}/api/contacts/all \
  --header 'apikey: <api-key>'
{
  "contacts": [
    {
      "jid": "[email protected]",
      "name": "John Silva",
      "notify": "John",
      "verifiedName": "John Silva",
      "businessName": ""
    },
    {
      "jid": "[email protected]",
      "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

​
sessionId
string
required
Authenticated session ID
{
  "contacts": [
    {
      "jid": "[email protected]",
      "name": "John Silva",
      "notify": "John",
      "verifiedName": "John Silva",
      "businessName": ""
    },
    {
      "jid": "[email protected]",
      "name": "Maria Santos",
      "notify": "Maria",
      "verifiedName": "Maria Santos",
      "businessName": ""
    }
  ]
}

​
Status Codes

  • 200 - Contacts returned successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized session
  • 404 - Session not found

​
Usage Example

curl -X GET "https://api.wappfy.com.br/api/contacts/all?sessionId=my-session"

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Query Parameters

​
sortBy
enum<string>

Sort by field

Available options:
id,
name
​
sortOrder
enum<string>

Sort order - descending (Z => A, New first) or ascending (A => Z, Old first)

Available options:
desc,
asc
​
limit
number
​
offset
number

Response

200 - undefined