Skip to main content
GET
/
api
/
v1
/
contacts
/
{contactId}
Get contact details
curl --request GET \
  --url http://localhost:{port}/api/v1/contacts/{contactId} \
  --header 'Authorization: Bearer <token>'
{
  "contact": {
    "id": "<string>",
    "name": "<string>",
    "number": "<string>",
    "isBusiness": true,
    "isEnterprise": true,
    "isMe": true,
    "isUser": true,
    "isGroup": true,
    "isWAContact": true,
    "isMyContact": true,
    "isBlocked": true,
    "pushname": "<string>",
    "shortName": "<string>"
  },
  "about": "<string>",
  "profilePicUrl": "<string>",
  "phoneNumber": {
    "full": "<string>",
    "formatted": "<string>",
    "countryCode": "<string>",
    "regionCode": "<string>",
    "number": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT token authentication

Path Parameters

contactId
string
required

ID of the contact to retrieve

Response

Contact details retrieved successfully

Detailed contact information

contact
object
required

Basic contact information

about
string

The contact's about/status message

profilePicUrl
string<uri>

URL of the contact's profile picture

phoneNumber
object

Structured phone number information