Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
contact

get contact details by ID

Retrieves detailed contact information for a specific contact using their ID. Returns contact details including name, number, business status, and various contact flags.

post/instances/{id}/client/action/get-contact-by-id

Path parameters

idinteger required

Instance ID

Request body

contactIdstring required

The ID of the contact in the format number@c.us

Example request

{
  "contactId": "1234567890@c.us"
}

Response

Contact details retrieved successfully

status'success' | 'error'

Example response

{
  "data": {
    "id": {
      "server": "c.us",
      "user": "1234567890",
      "_serialized": "1234567890@c.us"
    },
    "number": "1234567890",
    "name": "Contact Name",
    "pushname": "Contact Name",
    "shortName": "Contact",
    "type": "in",
    "isUser": true,
    "isWAContact": true,
    "isMyContact": true
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-contact-by-id"
  },
  "status": "success"
}