GET
/
api
/
public
/
whatsapp
/
contact
/
contacts
Get contacts
curl --request GET \
  --url https://api.vambe.me/api/public/whatsapp/contact/contacts \
  --header 'x-api-key: <x-api-key>'
🚨 DEPRECATED ENDPOINT - DO NOT USE FOR NEW INTEGRATIONSThis WhatsApp-specific endpoint is deprecated. Use the new universal contacts endpoint instead which supports ALL channels (WhatsApp, Instagram, SMS, etc.).

Deprecation Notice

This endpoint only returns WhatsApp contacts and is being phased out in favor of a more powerful, channel-agnostic endpoint. Get contacts from all channels (WhatsApp, Instagram, Web Chat, SMS, etc.) with better structure:
GET /api/public/contacts?days={days}
View Documentation Why migrate:
  • All Channels: WhatsApp, Instagram, SMS, Web Chat, and more
  • Better Performance: Optimized queries and indexing
  • Consistent Response: Standard AI Contact objects
  • Future-Proof: Active development and support
  • Ordered Results: Sorted by last_message_at descending

Migration Example

Old (Deprecated):
// Only gets WhatsApp contacts
await fetch(
  'https://api.vambe.ai/api/public/whatsapp/contact/contacts?days=30',
  {
    headers: {
      'x-api-key': 'your_api_key_here',
    },
  },
);
New (Recommended):
// Gets contacts from ALL channels
await fetch('https://api.vambe.ai/api/public/contacts?days=30', {
  headers: {
    'x-api-key': 'your_api_key_here',
  },
});

// Filter by WhatsApp if needed
const contacts = await response.json();
const whatsappOnly = contacts.filter((c) => c.platform === 'whatsapp');

Comparison

FeatureOld Endpoint (Deprecated)New Endpoint
ChannelsWhatsApp onlyAll channels
Response TypeWhatsApp Contact objectsAI Contact objects
OrderingNot specifiedBy last_message_at DESC
Path/api/public/whatsapp/contact/contacts/api/public/contacts
Support❌ Deprecated✅ Active

Migration Timeline

  • Now: Endpoint marked as deprecated
  • 6 months: Warning messages added to API responses
  • 12 months: Endpoint will be removed
Please migrate to the new endpoint to avoid service disruption.
⚠️ ACTION REQUIREDUpdate your integrations to use the new /api/public/contacts endpoint before this endpoint is removed in 12 months.

Headers

x-api-key
string
required

API key needed to authorize the request

Query Parameters

days
number
default:1
required

Number of days to get the contacts (1-365)

Required range: 1 < x < 365

Response

Contacts retrieved successfully.