Skip to main content
GET
/
{instance}
/
contacts
/
get
Get contact
curl --request GET \
  --url https://app.hypersender.com/api/whatsapp/v2/{instance}/contacts/get \
  --header 'Authorization: Bearer <token>'
{
  "message": "Contact retrieved successfully.",
  "data": {
    "id": "100875997589545@lid",
    "name": "Maria",
    "pushname": "Maria Doe"
  }
}
Retrieve detailed information about a specific contact in your WhatsApp instance. This endpoint allows you to:
  • Get contact details by phone number or chat ID
  • Retrieve the contact’s name and pushname
  • Verify contact information before sending messages
This is useful when you need to fetch information about a specific contact before interacting with them.

​
Use Cases

​
Contact Lookup

Quickly look up contact details using their phone number or chat ID.

​
Contact Verification

Verify that you have the correct contact information before sending important messages.

​
CRM Integration

Sync contact details from WhatsApp to your CRM system.

​
Request Parameters

​
chat_id

The contact identifier can be in one of these formats:

​
Response Examples

​
Successful Response

When the contact is found: 
{
  "message": "Contact retrieved successfully.",
  "data": {
    "id": "100875997589545@lid",
    "name": "Maria",
    "pushname": "Maria Doe"
  }
}

​
Contact Not Found

When the contact doesn’t exist: 
{
  "message": "Contact not found."
}

​
Best Practices

Store the contact ID (id field) for future API calls instead of repeatedly looking up the same contact.
The pushname is the name the user has set in their WhatsApp profile, while name is the name saved in your phone’s contacts.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept
string

application/json

Example:

"application/json"

​
Content-Type
string

application/json

Example:

"application/json"

Path Parameters

​
instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Query Parameters

​
chat_id
string
required

Phone number (123123123) or chat ID ([email protected] or 123123@lid)

Example:

"100875997589545@lid"

Response

Contact retrieved successfully

​
message
string
Example:

"Contact retrieved successfully."

​
data
object