Skip to main content
GET
/
api
/
v1
/
contact-lists
/
{listId}
/
contacts
List Contacts
curl --request GET \
  --url https://api.example.com/api/v1/contact-lists/{listId}/contacts
{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "customFields": {},
      "status": "<string>",
      "source": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "consentType": "<string>",
      "consentSource": "<string>",
      "consentTimestamp": "<string>",
      "consentIpAddress": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 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.

List all contacts in a list with optional filtering by status.

​
Path Parameters

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

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination.
​
limit
integer
default:"20"
Number of items per page (max 100).
​
status
string
Filter by contact status: active, unsubscribed, bounced, complained, or suppressed.

​
Examples

import { MailBreeze } from "mailbreeze";

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

// List all contacts
const { data, pagination } = await contacts.list();
console.log(`Found ${pagination.total} contacts`);

// List with status filter
const { data } = await contacts.list({
  status: "active",
  page: 1,
  limit: 50,
});

for (const contact of data) {
  console.log(`${contact.email}: ${contact.firstName} ${contact.lastName}`);
}

​
Response

​
data
array
Array of contact objects.
​
pagination
object
Pagination metadata.
Example Response
{
  "success": true,
  "data": {
    "contacts": [
      {
        "id": "8f1701be-0d2a-4519-999c-0574a3d68668",
        "domainId": "6911cf4253eb3ff3b4de6215",
        "contactListId": "694fc1669e63563857ae8d72",
        "email": "user@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "customFields": {},
        "status": "active",
        "source": "console",
        "subscriptionToken": "b839501cb01ca878a01bd2d8d947ad3350b53afbf5370d3b3e1999c958ce309a",
        "createdAt": "2025-12-27T12:36:25.458Z",
        "updatedAt": "2025-12-27T12:36:26.851Z"
      }
    ],
    "contactListCustomFields": {},
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100141,
      "totalPages": 5008
    }
  },
  "meta": {
    "timestamp": "2025-12-27T13:40:36.952Z",
    "requestId": "94718148-9068-497e-86d8-69b42030d011",
    "path": "/api/v1/contact-lists/694fc1669e63563857ae8d72/contacts"
  }
}