Skip to main content
GET
/
api
/
v1
/
contact-lists
/
{id}
/
stats
Get List Stats
curl --request GET \
  --url https://api.example.com/api/v1/contact-lists/{id}/stats
{
  "totalContacts": 123,
  "activeContacts": 123,
  "suppressedContacts": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.mailbreeze.com/llms.txt

Use this file to discover all available pages before exploring further.

Get aggregate statistics for a contact list including contact counts and engagement metrics.

​
Path Parameters

​
id
string
required
The unique list ID (e.g., lst_abc123).

​
Examples

import { MailBreeze } from "mailbreeze";

const mailbreeze = new MailBreeze({ apiKey: "sk_live_xxx" });

const stats = await mailbreeze.lists.stats("lst_abc123");

console.log(`Total contacts: ${stats.totalContacts}`);
console.log(`Active: ${stats.activeContacts}`);
console.log(`Unsubscribed: ${stats.unsubscribedContacts}`);
console.log(`Bounced: ${stats.bouncedContacts}`);

​
Response

​
totalContacts
integer
Total number of contacts in the list.
​
activeContacts
integer
Contacts eligible to receive emails.
​
suppressedContacts
integer
Contacts on the suppression list (bounced, complained, unsubscribed, etc.).
Example Response
{
  "success": true,
  "data": {
    "totalContacts": 1523,
    "activeContacts": 1520,
    "suppressedContacts": 3
  },
  "meta": {
    "timestamp": "2025-12-27T13:47:56.974Z",
    "requestId": "afa9e391-43d4-4594-820f-cc5e6b3b0c22",
    "path": "/api/v1/contact-lists/694fc1669e63563857ae8d72/stats"
  }
}

​
Understanding Contact States

StateDescriptionReceives Email?
ActiveEligible to receive emailsYes
SuppressedOn suppression list (bounced, complained, unsubscribed)No
totalContacts = activeContacts + suppressedContacts

​
Errors

CodeHTTP StatusDescription
NOT_FOUND404List with this ID doesn’t exist