v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB

WhatsApp Templates

List templates

Returns a paginated list of WhatsApp templates you've previously created.

Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.

get/whatsapp/templates

Query parameters

pageinteger

Page number of the results to be returned, 1-based.

limitinteger

A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.

includeTotalboolean

Return results inside an object that contains the total result count or not.

filter.wabaIdstring

Example:whatsapp-business-account-id

Required if you have more than 100 WABAs. WhatsApp Business Account ID.

filter.namestring

Example:sample_whatsapp_template

Name of the template.

filter.languagestring

Example:en

Language code of the template. See Supported Languages for all codes.

filter.statusstring

Example:APPROVED,ARCHIVED

Comma-separated template statuses to filter by. Supported values include PENDING, REJECTED, APPROVED, PAUSED, DISABLED, ARCHIVED, IN_APPEAL, and DELETED.

Response

Successfully retrieved a paginated list of objects.

offsetinteger required

The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.

limitinteger required

A limit on the number of items to be returned, between 1 and 100, defaults to 10.

lengthinteger required

The actual number of items in the page.

totalinteger

The total number of items. This field is returned only when the request parameter includeTotal is set to true.

itemsobject[]