Skip to main content
GET
/
api
/
v1
/
contact-lists
/
{id}
Get List
curl --request GET \
  --url https://api.example.com/api/v1/contact-lists/{id}
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "customFields": [
    {}
  ],
  "contactCount": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

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 detailed information about a specific contact list by its ID.

​
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 list = await mailbreeze.lists.get("lst_abc123");

console.log(list.name);         // "Newsletter Subscribers"
console.log(list.contactCount); // 1523
console.log(list.customFields); // [{ key: "company", label: "Company", type: "text" }]

​
Response

​
id
string
Unique list ID.
​
name
string
List name.
​
description
string
List description.
​
customFields
array
Custom field definitions.
​
contactCount
integer
Number of contacts in the list.
​
createdAt
string
ISO 8601 timestamp when created.
​
updatedAt
string
ISO 8601 timestamp when last updated.
Example Response
{
  "success": true,
  "data": {
    "domainId": "6911cf4253eb3ff3b4de6215",
    "userId": "68da571fdc22fcf0773dcb33",
    "name": "Test List",
    "description": "Test",
    "totalContacts": 1,
    "activeContacts": 1,
    "suppressedContacts": 0,
    "tags": [],
    "createdAt": "2025-12-27T11:22:14.221Z",
    "updatedAt": "2025-12-27T11:23:05.133Z",
    "id": "694fc1669e63563857ae8d72"
  },
  "meta": {
    "timestamp": "2025-12-27T13:40:04.368Z",
    "requestId": "714a056e-806b-411a-b39c-0ebc792b210f",
    "path": "/api/v1/contact-lists/694fc1669e63563857ae8d72"
  }
}

​
Errors

CodeHTTP StatusDescription
NOT_FOUND404List with this ID doesn’t exist