Get a bounce record | listmonk unofficial

1 parameter

idintegerrequired

The numeric identifier of the bounce record to retrieve.

1 status code

200Returns an object containing the bounce record data.

dataobjectoptional

Error handling

The id path parameter must be the numeric identifier of the bounce record you want to retrieve.

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.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": {
    "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": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Example Name"
        },
        "campaign_uuid": "550e8400-e29b-41d4-a716-446655440000",
        "total": 42
      }
    ]
  }
}

Request

Response

Errors