---
title: "Get template"
method: GET
path: "/v1/messaging/whatsapp/templates/{templateName}"
tags: ["WhatsApp"]
---

# Get template

`GET /v1/messaging/whatsapp/templates/{templateName}`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/whatsapp/templates/{templateName}`
- Auth: HTTP bearer

Retrieve one message template variant by name.

Meta stores one template per **name + language**, so a name identifies a family of variants,
each with its own Meta id. Pass `language` to address one variant. Without it, a name with a
single variant resolves to that variant; a name with several returns `409 ambiguous_template`
with `details.languages`. A bare language (`es`) matches a single regional variant (`es_ES`);
if the family has several regional variants for it, that is also a 409. A full code (`es_ES`)
must match exactly. Variants in `PENDING_DELETION` are not part of the family.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Path parameters

- `templateName` string, required: Template name (the family).

## Query parameters

- `language` string: Language code of the variant (e.g. en_US, es, pt_BR). Required when the family has several languages.
- `accountId` string, required: WhatsApp account ID

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `success` boolean
    - `template` object
      - `id` string: Meta template id. Unique per language variant; usable on /v1/whatsapp/templates/id/{templateId}.
      - `name` string
      - `status` string
      - `category` string
      - `language` string: The variant actually returned.
      - `components` object[]
      - `quality_score` object: Post-approval quality (GREEN/YELLOW/RED), when Meta reports one.
      - `rejected_reason` string: Only when status is REJECTED.
      - `message_send_ttl_seconds` integer: Only when a custom TTL is set; absent while the category default applies.
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)