Skip to main content
GET
/
api
/
contacts
Get basic contact information
curl --request GET \
  --url https://{host}/api/contacts \
  --header 'apikey: <api-key>'
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "John Silva",
      "notify": "John",
      "verifiedName": "John Silva",
      "businessName": ""
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

This endpoint allows getting basic information of contacts on WhatsApp. You can search for a specific contact by providing the JID or list multiple contacts using pagination.

​
Query Parameters

​
sessionId
string
required
Authenticated session ID
​
jid
string
Contact identifier (WhatsApp JID). If provided, returns only the specific contact. Format: 5511999999999@s.whatsapp.net
​
limit
number
default:"100"
Limit of contacts returned (default: 100)
​
offset
number
default:"0"
Offset for pagination (default: 0)
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "John Silva",
      "notify": "John",
      "verifiedName": "John Silva",
      "businessName": ""
    }
  ]
}

​
Status Codes

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

​
Usage Example

# Get specific contact
curl -X GET "https://api.wappfy.com.br/api/contacts?sessionId=my-session&jid=5511999999999@s.whatsapp.net"

# List contacts with pagination
curl -X GET "https://api.wappfy.com.br/api/contacts?sessionId=my-session&limit=50&offset=0"

Authorizations

​
apikey
string
header
required

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

Query Parameters

​
contactId
string
required

Response

200 - undefined