MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
WhatsApp

List templates

The number's message templates, as last synced, oldest first. Pass status=approved to see exactly the templates a send accepts. Sync the list with syncWhatsappTemplates first if a template you expect is missing.

Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.

GET/whatsapp/numbers//templates
Path parameters
number_idrequired
Query parameters
statusstring

Show only templates with this review status, such as approved, pending or rejected. Lower-case; omit it for all.

limitinteger

Rows per page.

cursorstring

The next_cursor from the previous page.

curl -X GET 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}/templates?limit=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "data": [
    {
      "id": 0,
      "name": "string",
      "language": "string",
      "category": "UTILITY",
      "status": "string",
      "rejected_reason": "string",
      "body_preview": "string",
      "header": {
        "type": "string",
        "has_file": false
      },
      "fields": [
        {
          "key": "string",
          "label": "string",
          "kind": "text",
          "required": false,
          "example": "string"
        }
      ],
      "buttons": [
        {
          "type": "string",
          "text": "string",
          "url": "string",
          "phone_number": "string"
        }
      ],
      "synced_at": "string"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

number_id*integer

Id of a WhatsApp number in your workspace, from listWhatsappNumbers. A number in another workspace answers 404.

Query Parameters

status?string

Show only templates with this review status, such as approved, pending or rejected. Lower-case; omit it for all.

limit?integer

Rows per page.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor from the previous page.

Response body

application/json

Response Body

One page of templates.

application/json
data?
has_more?boolean
next_cursor?string

Get a WhatsApp number

One number, with its status, quality and messaging limit, and what it can send. A number in another workspace answers 404.

Sync templates

Pull the number's templates and their review statuses from WhatsApp into your list. Run it after you create or edit a template in Meta. It runs at most once a minute per number: a second call inside that minute answers 429.