Get all subscribers

GET

/api/subscribers

Retrieve all subscribers for the authenticated user

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.maildesk.io/api/subscribers'

Response Example

{
    "subscribers": [
        {
            "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "status": "CONFIRMED",
            "tags": [
                "Newsletter",
                "Premium"
            ],
            "createdAt": "2024-03-20T10:00:00.000Z"
        }
    ],
    "total": 100,
    "page": 1,
    "limit": 10
}

Request

None

Responses

🟢200OK

application/json

Subscribers retrieved successfully

Body

subscribers

array[object (ContactResponseDto) {7}]

required

Array of subscribers

string

required

Unique identifier of the contact

Example:

01ARZ3NDEKTSV4RRFFQ69G5FAV

string

required

Email address of the contact

Example:

john.doe@example.com

firstName

string

required

First name of the contact

Example:

John

lastName

string

required

Last name of the contact

Example:

Doe

status

enum<string>

required

Subscription status of the contact

Allowed values:

CONFIRMEDUNSUBSCRIBEDUNCONFIRMEDPERMANENT_BOUNCE

Example:

CONFIRMED