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

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/action/get-contacts
Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully retrieved list of contacts.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "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
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.