Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
contact

get all contacts

Retrieves a list of all contacts from the account, including saved contacts and users who have messaged you.

post/instances/{id}/client/action/get-contacts

Path parameters

idinteger required

Instance ID

Response

Successfully retrieved list of contacts

status'success' | 'error'
instanceIdstring

Example response

{
  "status": "success",
  "instanceId": "1",
  "data": [
    {
      "id": {
        "server": "c.us",
        "user": "123456789012",
        "_serialized": "123456789012@c.us"
      },
      "number": "123456789012",
      "name": "John Doe",
      "pushname": "John",
      "shortName": "John",
      "type": "in",
      "isUser": true,
      "isWAContact": true,
      "isMyContact": true
    }
  ]
}