List Subscribers

curl -X GET "https://api.mailgreet.com/api/v1/external/subscribers?page=1&per_page=20&status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  page: '1',
  per_page: '20',
  status: 'active'
});

const response = await fetch(
  `https://api.mailgreet.com/api/v1/external/subscribers?${params}`,
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

params = {
    'page': 1,
    'per_page': 20,
    'status': 'active'
}

response = requests.get(
    'https://api.mailgreet.com/api/v1/external/subscribers',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    params=params
)

print(response.json())

<?php
$query = http_build_query([
    'page' => 1,
    'per_page' => 20,
    'status' => 'active'
]);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.mailgreet.com/api/v1/external/subscribers?{$query}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY'
    ]
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

{
  "success": true,
  "data": {
    "subscribers": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "status": "active",
        "created_at": "2026-01-13T12:00:00Z"
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "email": "jane@example.com",
        "first_name": "Jane",
        "last_name": "Smith",
        "status": "active",
        "created_at": "2026-01-13T12:00:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 5,
      "total_count": 100,
      "per_page": 20
    }
  }
}

{
  "success": false,
  "error": "Invalid or missing API key"
}

GET

api

external

subscribers

curl -X GET "https://api.mailgreet.com/api/v1/external/subscribers?page=1&per_page=20&status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  page: '1',
  per_page: '20',
  status: 'active'
});

const response = await fetch(
  `https://api.mailgreet.com/api/v1/external/subscribers?${params}`,
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

params = {
    'page': 1,
    'per_page': 20,
    'status': 'active'
}

response = requests.get(
    'https://api.mailgreet.com/api/v1/external/subscribers',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    params=params
)

print(response.json())

<?php
$query = http_build_query([
    'page' => 1,
    'per_page' => 20,
    'status' => 'active'
]);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.mailgreet.com/api/v1/external/subscribers?{$query}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY'
    ]
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

{
  "success": true,
  "data": {
    "subscribers": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "status": "active",
        "created_at": "2026-01-13T12:00:00Z"
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "email": "jane@example.com",
        "first_name": "Jane",
        "last_name": "Smith",
        "status": "active",
        "created_at": "2026-01-13T12:00:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 5,
      "total_count": 100,
      "per_page": 20
    }
  }
}

{
  "success": false,
  "error": "Invalid or missing API key"
}

Overview

Retrieve a paginated list of all subscribers in your MailGreet account. Use query parameters to filter, search, and paginate the results.

Authentication

string

required

Bearer token. Format: Bearer YOUR_API_KEY

Query Parameters

integer

default:"1"

Page number for pagination.

integer

default:"20"

Number of items per page. Maximum: 100.

string

Filter subscribers by status. Options:

active - Active subscribers
unsubscribed - Unsubscribed subscribers
bounced - Bounced email addresses
complained - Subscribers who marked emails as spam

string

Search by email address, first name, or last name. Case-insensitive.

string

Filter subscribers by group ID (UUID format).

Response

boolean

Indicates if the request was successful

object

Show data properties

array

Array of subscriber objects

Show Subscriber object

string

Unique identifier (UUID)

string

Email address

string

First name

string

Last name

string

Subscriber status

string

ISO 8601 timestamp

object

Show Pagination object

integer

Current page number

integer

Total number of pages

integer

Total number of subscribers matching the query

integer

Items per page

curl -X GET "https://api.mailgreet.com/api/v1/external/subscribers?page=1&per_page=20&status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  page: '1',
  per_page: '20',
  status: 'active'
});

const response = await fetch(
  `https://api.mailgreet.com/api/v1/external/subscribers?${params}`,
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

params = {
    'page': 1,
    'per_page': 20,
    'status': 'active'
}

response = requests.get(
    'https://api.mailgreet.com/api/v1/external/subscribers',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    params=params
)

print(response.json())

<?php
$query = http_build_query([
    'page' => 1,
    'per_page' => 20,
    'status' => 'active'
]);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.mailgreet.com/api/v1/external/subscribers?{$query}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY'
    ]
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

{
  "success": true,
  "data": {
    "subscribers": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "status": "active",
        "created_at": "2026-01-13T12:00:00Z"
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "email": "jane@example.com",
        "first_name": "Jane",
        "last_name": "Smith",
        "status": "active",
        "created_at": "2026-01-13T12:00:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 5,
      "total_count": 100,
      "per_page": 20
    }
  }
}

{
  "success": false,
  "error": "Invalid or missing API key"
}

Examples

Search for Subscribers

curl -X GET "https://api.mailgreet.com/api/v1/external/subscribers?search=john" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Subscribers in a Group

curl -X GET "https://api.mailgreet.com/api/v1/external/subscribers?group_id=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Paginate Through All Subscribers

async function getAllSubscribers() {
  let allSubscribers = [];
  let page = 1;
  let hasMore = true;

  while (hasMore) {
    const response = await fetch(
      `https://api.mailgreet.com/api/v1/external/subscribers?page=${page}&per_page=100`,
      {
        headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
      }
    );
    
    const data = await response.json();
    allSubscribers = allSubscribers.concat(data.data.subscribers);
    
    hasMore = page < data.data.pagination.total_pages;
    page++;
  }

  return allSubscribers;
}

Getting Started

Authentication

Subscribers

Webhooks

Health Check

Overview

Authentication

Query Parameters

Response

Examples

Search for Subscribers

Get Subscribers in a Group

Paginate Through All Subscribers

​Overview

​Authentication

​Query Parameters

​Response

​Examples

​Search for Subscribers

​Get Subscribers in a Group

​Paginate Through All Subscribers

Overview

Authentication

Query Parameters

Response

Examples

Search for Subscribers

Get Subscribers in a Group

Paginate Through All Subscribers