List unsubscribe groups

Offset pagination only (page[number] default 1, page[size] default 25, max 100). No sort/filter/cursor — ordering fixed desc created_at, desc id. Uses the shared QueryParser.parse_offset/1 — a malformed page (e.g. flat ?page=1 instead of ?page[number]=1) returns 400 (code 10015), consistent with GET /v2/email_blocks. meta includes total_pages.

GET /email_unsubscribe_groups

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailUnsubscribeGroups.list()) {
  console.log(response);
}

200

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "record_type": "email_unsubscribe_group",
      "name": "string",
      "description": "string",
      "created_at": "2024-01-23T18:10:02.574Z",
      "updated_at": "2024-01-23T18:10:02.574Z"
    }
  ],
  "meta": {
    "page_number": 0,
    "page_size": 0,
    "total_pages": 0,
    "total_results": 0
  }
}

Authorizations

Authorization · string · header · required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Query Parameters

page[number] · integer · default: 1

Offset page number (≥1, default 1).

Required range: x >= 1

page[size] · integer · default: 25

Page size (1–100, default 25).

Required range: 1 <= x <= 100

Response

200

application/json

Groups.

data · object[] · required

Show child attributes

meta · object · required

Group list meta (consistent with GET /v2/email_blocks).

Show child attributes