GET

List Contacts

Search, filter, and paginate through your stored WhatsApp contact list.

HTTP Endpoint

GEThttps://api-wa.hidessh.com/api/v1/contacts

Authentication

This endpoint requires Bearer authentication via your secret API Key.

Header Key	Value	Required
Authorization	Bearer <your_api_key>	Required
Content-Type	application/json	Required

Request Parameters

The request body must be formatted as JSON with the following parameters:

Parameter	Type	Required	Description
`search`	string	Optional	Filter contacts by name or phone query. example: Alex
`tag`	string	Optional	Filter contacts tagged with a specific tag name. example: VIP
`page`	integer	Optional	Page index. default: 1
`size`	integer	Optional	Number of contacts per page. default: 20

Code Examples

request.sh

curl -X GET "https://api-wa.hidessh.com/api/v1/contacts?search=Alex&page=1&size=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Formats

Paginated list of contacts.

application/json • 200 OK

{
  "success": true,
  "payload": [
    {
      "id": "01M1CT001",
      "name": "Alex Johnson",
      "phone": "628123456789",
      "tags": ["VIP", "Retail"],
      "custom_fields": { "city": "Jakarta" }
    }
  ],
  "additional_info": { "page": 1, "size": 20, "total": 1 }
}

On this page