> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tawked.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a template

> Reads one template by its Meta `id`, in full: its status, quality and rejection reason, its components as Meta holds them, the sample values, the placeholders a send must fill, and `managed`. An id that is not on the number's WhatsApp Business Account answers `404`.

Guide: [Templates](/whatsapp/templates)


## OpenAPI

````yaml https://tawked.com/openapi.json get /v1/whatsapp/templates/{template_id}
openapi: 3.1.0
info:
  title: Tawked API
  version: 2026-09
  summary: >-
    Tawked Verify: OTP verification for Saudi mobile numbers over SMS, in two
    calls. Tawked Notifications: WhatsApp template messages from the
    application's own number. The Partner API for platforms that run Tawked
    Verify for their merchants.
  description: >-
    The public API of Tawked, a Saudi messaging platform: Tawked Verify
    (one-time codes), Tawked Notifications (WhatsApp templates from the
    application's own number) and the Partner API. Tawked Verify is an OTP
    verification API for Saudi numbers. One call sends a one-time code by SMS to
    a Saudi mobile number, and a second call checks it. SAR 0.09 per SMS code
    sent, prepaid; a send the network refuses is refunded. Authenticate with a
    Bearer API key from the dashboard (tk_live_ for production, tk_test_ for the
    sandbox, tk_partner_ for partners, tk_partner_test_ for the partner
    sandbox). Partners (tk_partner_) provision a Verify application per merchant
    under /v1/partner/applications and name it as application on every Verify
    call. Both /v1/... and /api/v1/... answer identically. Rate limit: 120
    requests per minute per key.
  termsOfService: https://tawked.com/en/terms
  license:
    name: Proprietary (Tawked terms of service)
    url: https://tawked.com/en/terms
  contact:
    name: Tawked support
    email: support@tawked.com
    url: https://tawked.com/en/contact
servers:
  - url: https://tawked.com
    description: Production (the sandbox is a tk_test_ key on the same host)
  - url: https://tawked.com/api
    description: The same API under /api/v1/..., kept for older integrations
security:
  - bearerKey: []
  - headerKey: []
tags:
  - name: Verify
    x-group: Verify
    description: Send and check one-time codes.
  - name: WhatsApp
    x-group: Notifications
    description: >-
      Tawked Notifications: send approved WhatsApp templates through the number
      connected to an application. An application in review or approved connects
      its own number from the dashboard.
  - name: Partner
    x-group: Partner API
    description: >-
      For platforms that run Tawked Verify for their merchants: provision a
      Verify application per merchant, keep its brand and verify settings
      current, switch it off and on, and read usage and the code log. Partner
      keys (tk_partner_) only; every Verify operation then takes `application`
      with the partner's own id for the application.
  - name: Webhooks
    x-group: Webhooks
    description: >-
      The events Tawked sends to your endpoint: an application's verification
      outcomes and message statuses, and a partner account's lifecycle, balance
      and opt-in verification events. Every delivery is signed the same way and
      retried the same way.
externalDocs:
  description: Developer docs, with code samples
  url: https://docs.tawked.com
paths:
  /v1/whatsapp/templates/{template_id}:
    get:
      tags:
        - WhatsApp
      summary: Get a template
      description: >-
        Reads one template by its Meta `id`, in full: its status, quality and
        rejection reason, its components as Meta holds them, the sample values,
        the placeholders a send must fill, and `managed`. An id that is not on
        the number's WhatsApp Business Account answers `404`.
      operationId: whatsapp_template
      parameters:
        - name: template_id
          in: path
          required: true
          schema:
            type: string
          description: >-
            The template's Meta id, as `id` in `GET /v1/whatsapp/templates`. One
            id is one language of a template.
      responses:
        '200':
          description: The template
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  language:
                    type: string
                  category:
                    type: string
                  status:
                    type: string
                  quality:
                    type: string
                  rejected_reason:
                    type:
                      - string
                      - 'null'
                  components:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        format:
                          type: string
                        text:
                          type: string
                        buttons:
                          type: array
                          items:
                            type:
                              - string
                              - 'null'
                  examples:
                    type: object
                    properties:
                      header:1:
                        type: string
                      body:1:
                        type: string
                      body:2:
                        type: string
                      button:0:
                        type: string
                  placeholders:
                    type: object
                    properties:
                      kind:
                        type: string
                      header:
                        type: array
                        items:
                          type: string
                      body:
                        type: array
                        items:
                          type: string
                      buttons:
                        type: array
                        items:
                          type: object
                          properties:
                            index:
                              type: integer
                            type:
                              type: string
                  managed:
                    type: boolean
              examples:
                the_template:
                  summary: The template
                  value:
                    id: '7000'
                    name: order_received_v1
                    language: ar
                    category: UTILITY
                    status: APPROVED
                    quality: GREEN
                    rejected_reason: null
                    components:
                      - type: HEADER
                        format: TEXT
                        text: طلبك {{1}}
                        buttons: []
                      - type: BODY
                        format: null
                        text: استلمنا طلبك رقم {{1}} بقيمة {{2}} ريال.
                        buttons: []
                      - type: BUTTONS
                        format: null
                        text: null
                        buttons:
                          - type: URL
                            text: تتبع الطلب
                            url: https://flowers.example/orders/{{1}}
                            phone_number: null
                    examples:
                      header:1: '1042'
                      body:1: '1042'
                      body:2: '250'
                      button:0: '1042'
                    placeholders:
                      kind: positional
                      header:
                        - '1'
                      body:
                        - '1'
                        - '2'
                      buttons:
                        - index: 0
                          type: url
                    managed: false
        '401':
          description: >-
            `unauthorized`: Missing, unknown, revoked, or mode-mismatched key;
            or an unknown/suspended partner.; `key_expired`: The key's
            `expires_at` has passed. Checked right after the key is recognised,
            before the IP allowlist or scope.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - unauthorized
                          - key_expired
        '403':
          description: >-
            `account_not_active`: The application is not approved yet, the
            account is banned, or a partner disabled this application. All four
            causes share this one response.; `ip_not_allowed`: The caller's IP
            does not match the key's `ip_allowlist` (exact IPs and/or CIDR
            ranges, IPv4 and IPv6).; `insufficient_scope`: The key was not
            granted this call: a custom key without this product, or with a
            level below the call, such as a key that checks where the call
            sends. The response header `WWW-Authenticate` names the scope the
            call needs. Judged right after the key is recognised, before
            `account_not_active` and the request's shape. This operation needs
            `notifications:read`.; `live_key_required`: A sandbox (tk_test_)
            key. WhatsApp has no sandbox yet; use the application's live key.;
            `whatsapp_not_enabled`: WhatsApp is turned off for this application.
            Message support if you think this is a mistake.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - account_not_active
                          - ip_not_allowed
                          - insufficient_scope
                          - live_key_required
                          - whatsapp_not_enabled
          headers:
            WWW-Authenticate:
              description: >-
                Sent with `insufficient_scope` only: the scope this operation
                needs, which the key was not granted.
              schema:
                type: string
              example: Bearer error="insufficient_scope", scope="notifications:read"
        '404':
          description: >-
            Not on this number / `not_found`: Unknown id, or an id that belongs
            to a different account or application than the calling key's.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - not_found
              examples:
                not_on_this_number:
                  summary: Not on this number
                  value:
                    error: not_found
        '409':
          description: >-
            `no_whatsapp_number`: No WhatsApp number is connected to this
            application yet. Connect one from the Number section of the
            application's Notifications tab in the dashboard (Getting started,
            step 1).
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - no_whatsapp_number
        '429':
          description: >-
            `too_many_requests`: Per-key rate limit exceeded (default 120
            requests/minute, fixed 60s window). Checked before authentication.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - too_many_requests
        '500':
          description: >-
            `internal_error`: An unhandled server error. Quote the X-Request-Id
            header if you report it.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - internal_error
        '503':
          description: >-
            `templates_unavailable`: Meta did not answer the read of the
            number's template list, which the template endpoints and a send need
            before anything happens, or did not answer a template write. Nothing
            was sent, changed or charged; retry shortly.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - templates_unavailable
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://tawked.com/v1/whatsapp/templates/7000 \
              -H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx"
        - lang: javascript
          label: Node.js
          source: >-
            const res = await
            fetch("https://tawked.com/v1/whatsapp/templates/7000", {
              headers: {
                Authorization: "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx",
              },
            });

            const data = await res.json();
        - lang: python
          label: Python
          source: |-
            import requests

            res = requests.get(
                "https://tawked.com/v1/whatsapp/templates/7000",
                headers={"Authorization": "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx"},
            )
            data = res.json()
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: A stable machine-readable code; the docs list every one.
      additionalProperties: true
  securitySchemes:
    bearerKey:
      type: http
      scheme: bearer
      description: >-
        Authorization: Bearer <api key>. An application key (tk_live_, tk_test_)
        has full access, which covers every product and any product added later,
        or custom access, chosen when the key is created: one or more of the
        scopes `verify:check`, `verify:send` (includes `verify:check`),
        `notifications:read`, `notifications:send` (includes
        `notifications:read`), `notifications:templates` (includes
        `notifications:read`). No key made on the API keys page holds
        `notifications:templates`, full access included: the three template
        writes answer such a key 403 `insufficient_scope`. A connected app's key
        holds it. A call outside the key's access answers 403
        `insufficient_scope` and names the scope it needs in the
        `WWW-Authenticate` response header. A partner key (tk_partner_) always
        has full access. Whatever its access, a key is a server-side secret.
    headerKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        The same API key, with the same access, as a header, for clients that
        cannot set Authorization.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.