Get all contacts

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": "5511999999999@c.us",
    "pushname": "John",
    "name": "John Doe"
  }
]

Authorization

string

header

required

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

instanceId

string<uuid>

required

The WhatsApp instance UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

List of contacts

string

required

Contact WhatsApp ID

Example:

"5511999999999@c.us"

pushname

string

Push name set by the contact

Example:

"John"

name

string

Contact name from address book

Example:

"John Doe"

Get all contacts

curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/contacts \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "5511999999999@c.us",
    "pushname": "John",
    "name": "John Doe"
  }
]