Skip to main content
GET
/
api
/
instances
/
{instanceId}
/
contacts
Get all contacts
curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/contacts \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "[email protected]",
    "pushname": "John",
    "name": "John Doe"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
instanceId
string<uuid>
required

The WhatsApp instance UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

List of contacts

​
id
string
required

Contact WhatsApp ID

Example:

"[email protected]"

​
pushname
string

Push name set by the contact

Example:

"John"

​
name
string

Contact name from address book

Example:

"John Doe"