List All Lists

curl --request GET \
  --url https://api.example.com/api/v1/contact-lists

import requests

url = "https://api.example.com/api/v1/contact-lists"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/contact-lists', 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",
  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"

	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")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/contact-lists")

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>",
  "totalContacts": 123,
  "activeContacts": 123,
  "suppressedContacts": 123,
  "tags": [
    {}
  ],
  "customFields": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

GET

api

contact-lists

List All Lists

curl --request GET \
  --url https://api.example.com/api/v1/contact-lists

import requests

url = "https://api.example.com/api/v1/contact-lists"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/contact-lists', 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",
  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"

	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")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/contact-lists")

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>",
  "totalContacts": 123,
  "activeContacts": 123,
  "suppressedContacts": 123,
  "tags": [
    {}
  ],
  "customFields": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Retrieve all contact lists for your domain.

Examples

import { MailBreeze } from "mailbreeze";

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

// List all contact lists
const { data, pagination } = await mailbreeze.lists.list();

console.log(`Found ${pagination.total} lists`);

for (const list of data) {
  console.log(`${list.name}: ${list.contactCount} contacts`);
}

// With pagination
const { data } = await mailbreeze.lists.list({ page: 2, limit: 10 });

from mailbreeze import MailBreeze

client = MailBreeze(api_key="sk_live_xxx")

# List all contact lists
result = await client.lists.list()
print(f"Found {result.pagination.total} lists")

for list in result.data:
    print(f"{list.name}: {list.contact_count} contacts")

# With pagination
result = await client.lists.list(page=2, limit=10)

client := mailbreeze.NewClient("sk_live_xxx")

// List all contact lists
result, err := client.Lists.List(ctx, nil)
if err != nil {
    log.Fatal(err)
}

fmt.Printf("Found %d lists\n", result.Pagination.Total)

for _, list := range result.Data {
    fmt.Printf("%s: %d contacts\n", list.Name, list.ContactCount)
}

// With pagination
result, err := client.Lists.List(ctx, &mailbreeze.ListListsParams{
    Page:  2,
    Limit: 10,
})

$mailbreeze = new MailBreeze('sk_live_xxx');

// List all contact lists
$response = $mailbreeze->lists->list();

foreach ($response['data'] as $list) {
    echo $list['name'] . ": " . $list['totalContacts'] . " contacts\n";
}

let client = Client::new("sk_live_xxx");

// List all contact lists
let result = client.lists().list(None).await?;
println!("Found {} lists", result.pagination.total);

for list in result.data {
    println!("{}: {} contacts", list.name, list.contact_count);
}

// With pagination
let result = client.lists().list(Some(ListListsParams {
    page: Some(2),
    limit: Some(10),
})).await?;

curl "https://api.mailbreeze.com/api/v1/contact-lists" \
  -H "Authorization: Bearer sk_live_xxx"

Response

string

Unique list ID.

name

string

List name.

description

string

List description.

totalContacts

integer

Total number of contacts in the list.

activeContacts

integer

Number of active contacts.

suppressedContacts

integer

Number of suppressed contacts.

​Examples

​Response

Examples

Response