List bounce records | listmonk unofficial

6 parameters

campaign_idintegeroptional

The numeric identifier of the campaign whose bounce records you want to retrieve.

pageintegeroptional

The page number for paginated results, starting at 1.

per_pageintegeroptional

The number of records per page as an integer, or `all` to return all results.

sourcestringoptional

Filter bounce records by their source of origin.

order_bystringoptional

The field to sort by: `email`, `campaign_name`, `source`, or `created_at`.

Allowed:emailcampaign_namesourcecreated_at

orderstringoptional

The sort direction: `asc` for ascending or `desc` for descending.

Allowed:ascdesc

1 status code

200Returns paginated bounce records with results, the query, total count, page number, and page size.

dataobjectoptional

Error handling

per_page accepts an integer or all, and page starts at 1 for the first page. order_by must be email, campaign_name, source, or created_at; order must be asc or desc.

import { Client } from "listmonk-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:9000/api",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
});

const result = await client.bounces.list({
  campaignId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  page: 1,
  perPage: 20,
  source: "example",
  orderBy: "example",
});

{
  "data": {
    "results": [
      {
        "results": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "type": "standard",
            "source": "example_value",
            "created_at": "example_value",
            "email": "user@example.com",
            "subscriber_uuid": "550e8400-e29b-41d4-a716-446655440000",
            "subscriber_id": "550e8400-e29b-41d4-a716-446655440000",
            "campaign": {
              "id": null,
              "name": null
            },
            "campaign_uuid": "550e8400-e29b-41d4-a716-446655440000",
            "total": 42
          }
        ]
      }
    ],
    "query": "search term",
    "total": 42,
    "per_page": 1,
    "page": 1
  }
}

Request

Response

Errors