---
title: "get contact details by ID"
method: POST
path: "/instances/{id}/client/action/get-contact-by-id"
tags: ["contact"]
---

# get contact details by ID

`POST /instances/{id}/client/action/get-contact-by-id`

## Request

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

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

## Path parameters

- `id` integer, required

## Request body

- object
  - `contactId` string, required: Contact ID: `<number>@c.us` or `<lid>@lid`.

## Response `200`

Request reached the instance. `data.status` reports whether the action was carried out; on error `data` carries `message` and `explanation`. Payload: Contact details retrieved successfully.

- object
  - `data` union: The action's outcome. `status: success` carries the payload; `status: error` is an `actionError`.
    - object
      - `status` 'success', required: Whether the instance carried the action out — the authoritative field. In this branch it is always `success`; when the instance refused the action the whole `data` object is an `actionError` with `status: error`, `message` and `explanation`.
      - `instanceId` union
        - integer
        - string
      - `data` object
        - `id` object
          - `server` string
          - `user` string
          - `_serialized` string
        - `number` string: Contact's phone number
        - `isBusiness` boolean: Whether the contact is a Business account
        - `isEnterprise` boolean: Whether the contact is a Enterprise account
        - `labels` unknown[]: Array of contact labels
          - unknown
        - `name` string: Contact's full name
        - `pushname` string: Contact's display name
        - `shortName` string: Contact's short or first name
        - `type` string: Contact type
        - `isMe` boolean: Whether this contact represents the current user
        - `isUser` boolean: Whether this is a regular user
        - `isGroup` boolean: Whether this is a group chat
        - `isWAContact` boolean: Whether this contact has a account
        - `isMyContact` boolean: Whether this contact is in the user's address book
        - `isBlocked` boolean: Whether this contact is blocked by the user
    - ActionError: Shape of `data` when the instance refused the action. HTTP status is still 200 and the outer `status` is still `success`.
      - `status` 'error', required
      - `message` string
      - `explanation` string
      - `instanceId` union
        - integer
        - string
  - `links` object
    - `self` string
  - `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`.

## Other responses

- `401`: Unauthorized — invalid or missing bearer token
- `403`: Forbidden — insufficient permissions or account blocked
- `404`: Not found — instance does not exist or does not belong to you
- `409`: Conflict — instance is not ready
- `422`: Validation error — invalid or missing request parameters
- `429`: Too many requests — rate limit exceeded

---

[API](https://skmtc.dev/waapi/apis/waapi-api-2.md) · [All operations](https://skmtc.dev/waapi/apis/waapi-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/waapi/apis/waapi-api-2/revisions/490302f75576?raw)