API Reference

List Events

GET /events — list your custom event definitions.

GET/events

Lists your custom event definitions. This endpoint is always paginated: limit defaults to 20 even when you do not send it, so an account with more definitions than that gets one page plus has_more: true. Page through the rest with after.

Query parameters

limitnumberoptional

Number of event definitions to retrieve. Minimum 1, maximum 100, default 20.

afterstringoptional

The id after which to retrieve more definitions (for pagination). Not included in the result. Cannot be combined with before.

beforestringoptional

The id before which to retrieve more definitions (for pagination). Not included in the result. Cannot be combined with after.

import { Mailblastr } from 'mailblastr';

const mb = new Mailblastr('mb_xxxxxxxxx');

const { data, error } = await mb.events.list();
console.log({ data, error });

Response

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "event",
      "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
      "name": "user.created",
      "schema": {
        "plan": "string"
      },
      "created_at": "2026-06-23T10:00:00.000Z",
      "updated_at": "2026-06-23T10:00:00.000Z"
    }
  ]
}

Returns validation_error if limit is outside 1–100 or if both after and before are supplied. See Errors and Pagination.