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

# Get template



## OpenAPI

````yaml /en/template-api/api-reference/openapi-templates.json get /v1/templates/{id}
openapi: 3.0.3
info:
  title: Notifique API - Templates
  description: >-
    CRUD de templates multicanal e envio. Canais: whatsapp, sms, email,
    telegram, rcs, push, voice. Instagram e Widget nao sao canais de template.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producao
security:
  - BearerAuth: []
  - ApiKeyHeader: []
tags:
  - name: Templates
    description: Templates multicanal e envio
paths:
  /v1/templates/{id}:
    get:
      tags:
        - Templates
      summary: Get template
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: cltmpl01abc
      responses:
        '200':
          description: Template
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateResponse'
              examples:
                ok:
                  summary: Detail do template
                  value:
                    success: true
                    data:
                      id: cltmpl01abc
                      workspaceId: clws01xyz
                      name: alerta_pedido
                      category: TRANSACTIONAL
                      language: pt_BR
                      source: null
                      status: ACTIVE
                      metaId: null
                      type: null
                      components: null
                      variables:
                        - codigo
                        - name
                      variableDefaults:
                        name: Cliente
                      usageCount: 12
                      lastUsedAt: '2026-07-08T10:15:00.000Z'
                      marketingTopicId: null
                      appendPreferencesLink: true
                      localeTranslations: null
                      enabledChannels:
                        - sms
                        - email
                        - whatsapp
                      sms:
                        enabled: true
                        payload:
                          content: Pedido {{codigo}} despachado, {{name}}.
                      whatsapp:
                        enabled: true
                        payload:
                          content: Ola {{name}}, pedido {{codigo}} saiu para entrega.
                          mediaUrl: null
                          buttons: null
                      telegram:
                        enabled: false
                        payload:
                          content: ''
                          mediaUrl: null
                          buttons: null
                      email:
                        enabled: true
                        payload:
                          subject: Pedido {{codigo}}
                          html: <p>Ola {{name}}, seu pedido saiu.</p>
                          containerWidth: 600
                          containerPadding: 24
                          imageUrls: null
                          buttons: null
                      rcs:
                        enabled: false
                        payload:
                          messageType: BASIC
                          message: ''
                          payload: null
                      push:
                        enabled: false
                        payload:
                          title: null
                          body: null
                          url: null
                          icon: null
                          image: null
                          data: null
                      voice:
                        enabled: false
                        payload:
                          speakText: ''
                          speakVoice: null
                          gather: null
                      createdAt: '2026-06-01T12:00:00.000Z'
                      updatedAt: '2026-07-01T09:30:00.000Z'
        '404':
          description: Nao encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error: Not Found
                message: Template not found
                code: NOT_FOUND
components:
  schemas:
    TemplateResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/TemplateObject'
      example:
        success: true
        data:
          id: cltmpl01abc
          workspaceId: clws01xyz
          name: alerta_pedido
          category: TRANSACTIONAL
          language: pt_BR
          source: null
          status: ACTIVE
          metaId: null
          type: null
          components: null
          variables:
            - codigo
            - name
          variableDefaults:
            name: Cliente
          usageCount: 12
          lastUsedAt: '2026-07-08T10:15:00.000Z'
          marketingTopicId: null
          appendPreferencesLink: true
          localeTranslations: null
          enabledChannels:
            - sms
            - email
            - whatsapp
          sms:
            enabled: true
            payload:
              content: Pedido {{codigo}} despachado, {{name}}.
          whatsapp:
            enabled: true
            payload:
              content: Ola {{name}}, pedido {{codigo}} saiu para entrega.
              mediaUrl: null
              buttons: null
          telegram:
            enabled: false
            payload:
              content: ''
              mediaUrl: null
              buttons: null
          email:
            enabled: true
            payload:
              subject: Pedido {{codigo}}
              html: <p>Ola {{name}}, seu pedido saiu.</p>
              containerWidth: 600
              containerPadding: 24
              imageUrls: null
              buttons: null
          rcs:
            enabled: false
            payload:
              messageType: BASIC
              message: ''
              payload: null
          push:
            enabled: false
            payload:
              title: null
              body: null
              url: null
              icon: null
              image: null
              data: null
          voice:
            enabled: false
            payload:
              speakText: ''
              speakVoice: null
              gather: null
          createdAt: '2026-06-01T12:00:00.000Z'
          updatedAt: '2026-07-01T09:30:00.000Z'
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Bad Request
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          example: Template not found
          description: >-
            Message legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          example: INSUFFICIENT_CREDITS
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Responses de
            erro](/guides/conceitos/resposta-de-erros).
        missingVariables:
          type: array
          items:
            type: string
          example:
            - codigo
            - name
      required:
        - success
        - error
        - message
        - code
    TemplateObject:
      type: object
      required:
        - id
        - workspaceId
        - name
        - enabledChannels
        - sms
        - whatsapp
        - telegram
        - email
        - rcs
        - push
        - voice
      properties:
        id:
          type: string
          example: cltmpl01abc
        workspaceId:
          type: string
          example: clws01xyz
        name:
          type: string
          example: alerta_pedido
        category:
          type: string
          enum:
            - MARKETING
            - TRANSACTIONAL
            - NOTIFICATION
            - AUTHENTICATION
            - CUSTOM
          example: TRANSACTIONAL
        language:
          type: string
          example: pt_BR
        source:
          type: string
          nullable: true
          enum:
            - ZENVIO
            - WHATSAPP_OFFICIAL
          description: >-
            Origem do template. `WHATSAPP_OFFICIAL` = catálogo Meta (WABA).
            `ZENVIO` ou null = template interno Notifique.
          example: null
        status:
          type: string
          example: ACTIVE
        metaId:
          type: string
          nullable: true
          description: ID do message_template na Graph (quando official).
          example: null
        metaName:
          type: string
          nullable: true
          description: >-
            Nome Graph do template (`a-z`, `0-9`, `_`). Usado no envio Cloud;
            pode diferir do `name` interno.
          example: hello_world
        metaWabaId:
          type: string
          nullable: true
          description: WABA de origem do template official.
          example: null
        type:
          type: string
          nullable: true
          example: null
        components:
          nullable: true
          description: >-
            Componentes Meta (HEADER/BODY/FOOTER/BUTTONS/CAROUSEL) quando
            `source` é WHATSAPP_OFFICIAL.
          example: null
        variables:
          type: array
          items:
            type: string
          example:
            - codigo
            - name
        variableDefaults:
          type: object
          additionalProperties:
            type: string
          example:
            name: Cliente
        usageCount:
          type: integer
          example: 12
        lastUsedAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-07-08T10:15:00.000Z'
        marketingTopicId:
          type: string
          nullable: true
          example: null
        appendPreferencesLink:
          type: boolean
          example: true
        localeTranslations:
          nullable: true
          example: null
        enabledChannels:
          type: array
          items:
            type: string
            enum:
              - sms
              - whatsapp
              - telegram
              - email
              - rcs
              - push
              - voice
          example:
            - sms
            - email
            - whatsapp
        sms:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: true
            payload:
              content: Pedido {{codigo}} despachado, {{name}}.
        whatsapp:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: true
            payload:
              content: Ola {{name}}, pedido {{codigo}} saiu para entrega.
              mediaUrl: null
              buttons: null
        telegram:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: false
            payload:
              content: ''
              mediaUrl: null
              buttons: null
        email:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: true
            payload:
              subject: Pedido {{codigo}}
              html: <p>Ola {{name}}, seu pedido saiu.</p>
              containerWidth: 600
              containerPadding: 24
              imageUrls: null
              buttons: null
        rcs:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: false
            payload:
              messageType: BASIC
              message: ''
              payload: null
        push:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: false
            payload:
              title: null
              body: null
              url: null
              icon: null
              image: null
              data: null
        voice:
          allOf:
            - $ref: '#/components/schemas/ChannelEnabledPayload'
          example:
            enabled: false
            payload:
              speakText: ''
              speakVoice: null
              gather: null
        createdAt:
          type: string
          format: date-time
          example: '2026-06-01T12:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-07-01T09:30:00.000Z'
      example:
        id: cltmpl01abc
        workspaceId: clws01xyz
        name: alerta_pedido
        category: TRANSACTIONAL
        language: pt_BR
        source: null
        status: ACTIVE
        metaId: null
        type: null
        components: null
        variables:
          - codigo
          - name
        variableDefaults:
          name: Cliente
        usageCount: 12
        lastUsedAt: '2026-07-08T10:15:00.000Z'
        marketingTopicId: null
        appendPreferencesLink: true
        localeTranslations: null
        enabledChannels:
          - sms
          - email
          - whatsapp
        sms:
          enabled: true
          payload:
            content: Pedido {{codigo}} despachado, {{name}}.
        whatsapp:
          enabled: true
          payload:
            content: Ola {{name}}, pedido {{codigo}} saiu para entrega.
            mediaUrl: null
            buttons: null
        telegram:
          enabled: false
          payload:
            content: ''
            mediaUrl: null
            buttons: null
        email:
          enabled: true
          payload:
            subject: Pedido {{codigo}}
            html: <p>Ola {{name}}, seu pedido saiu.</p>
            containerWidth: 600
            containerPadding: 24
            imageUrls: null
            buttons: null
        rcs:
          enabled: false
          payload:
            messageType: BASIC
            message: ''
            payload: null
        push:
          enabled: false
          payload:
            title: null
            body: null
            url: null
            icon: null
            image: null
            data: null
        voice:
          enabled: false
          payload:
            speakText: ''
            speakVoice: null
            gather: null
        createdAt: '2026-06-01T12:00:00.000Z'
        updatedAt: '2026-07-01T09:30:00.000Z'
    ChannelEnabledPayload:
      type: object
      required:
        - enabled
        - payload
      properties:
        enabled:
          type: boolean
          example: true
        payload:
          type: object
          additionalProperties: true
          description: >-
            Campos do canal (content, subject, html, messageType, title,
            speakText, etc.)
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````