Get List
curl --request GET \
--url https://api.example.com/api/v1/contact-lists/{id}import requests
url = "https://api.example.com/api/v1/contact-lists/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/contact-lists/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/contact-lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/contact-lists/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/contact-lists/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/contact-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"customFields": [
{}
],
"contactCount": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}Lists
Get List
Retrieve a specific contact list
GET
/
api
/
v1
/
contact-lists
/
{id}
Get List
curl --request GET \
--url https://api.example.com/api/v1/contact-lists/{id}import requests
url = "https://api.example.com/api/v1/contact-lists/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/contact-lists/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/contact-lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/contact-lists/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/contact-lists/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/contact-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"customFields": [
{}
],
"contactCount": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}Get detailed information about a specific contact list by its ID.
Path Parameters
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" }]
from mailbreeze import MailBreeze
client = MailBreeze(api_key="sk_live_xxx")
list = await client.lists.get("lst_abc123")
print(list.name) # "Newsletter Subscribers"
print(list.contact_count) # 1523
print(list.custom_fields) # [{"key": "company", "label": "Company", "type": "text"}]
client := mailbreeze.NewClient("sk_live_xxx")
list, err := client.Lists.Get(ctx, "lst_abc123")
if err != nil {
log.Fatal(err)
}
fmt.Println(list.Name) // "Newsletter Subscribers"
fmt.Println(list.ContactCount) // 1523
$mailbreeze = new MailBreeze('sk_live_xxx');
$response = $mailbreeze->lists->get('lst_abc123');
$list = $response['data'];
echo $list['name']; // "Newsletter Subscribers"
echo $list['totalContacts']; // 1523
let client = Client::new("sk_live_xxx");
let list = client.lists().get("lst_abc123").await?;
println!("{}", list.name); // "Newsletter Subscribers"
println!("{}", list.contact_count); // 1523
curl "https://api.mailbreeze.com/api/v1/contact-lists/694fc1669e63563857ae8d72" \
-H "Authorization: Bearer sk_live_xxx"
Response
string
Unique list ID.
string
List name.
string
List description.
array
Custom field definitions.
integer
Number of contacts in the list.
string
ISO 8601 timestamp when created.
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
| Code | HTTP Status | Description |
|---|---|---|
NOT_FOUND | 404 | List with this ID doesn’t exist |