Skip to main content
GET
/
whatsapp
/
message_templates
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 whatsappTemplateData of client.whatsapp.templates.list()) {
  console.log(whatsappTemplateData.id);
}
{
  "data": [
    {
      "id": "<string>",
      "record_type": "whatsapp_message_template",
      "template_id": "<string>",
      "name": "<string>",
      "category": "MARKETING",
      "language": "<string>",
      "status": "<string>",
      "rejection_reason": "<string>",
      "components": [
        {}
      ],
      "whatsapp_business_account": {
        "id": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

​
filter[waba_id]
string

Filter by WABA ID

​
filter[category]
enum<string>

Filter by category

Available options:
MARKETING,
UTILITY,
AUTHENTICATION
​
filter[status]
string

Filter by template status

​
filter[search]
string

Search templates by name

Response

Whatsapp templates list

​
data
object[]
​
meta
object