Get LIDs Count
Returns the number of known LIDs.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Use this for debugging synchronization issues.
Monitor this count to track migration to the new architecture.
Measuring Your Identity Graph: LID Count
The /v2/lids/count endpoint returns a simple integer: the total number of LID-to-Phone mappings your session has cached.
📊 What This Number Means
This is not the number of contacts you have. It is the number of privacy-aware identities your bot has encountered.
Interpretation
- Count = 0: Your account is very new or you only interact with legacy users.
- Count = 50: You have interacted with 50 users who have modern WhatsApp accounts with LIDs.
- Count = 10,000: You run a large-scale bot that has processed thousands of unique users.
🛠️ Use Cases
1. Pagination Planning
Before calling /v2/lids to fetch the full list, check the count.
- If
count < 100: Fetch everything in one call. - If
count > 10,000: Use aggressive pagination (limit=1000, offset=0...10000).
2. Analytics Dashboard
Display this metric to your operations team.
- Metric: "Unique Privacy-Aware Users".
- Trend: If this number grows faster than your total contact count, it means more users are adopting WhatsApp's privacy features.
3. Cache Warming
If you are migrating to a new server, you can use this count to estimate how long it will take to rebuild your LID cache.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
URL Parameters
Passed in the URL query stringstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"count": 42
}Command Palette
Search for a command to run...