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

# Listar templates de mensagem

> Lista os templates de WhatsApp (oficial e não oficial), e-mail e SMS que um flow pode enviar, com prévia do texto, status de aprovação do WhatsApp e o dado do cliente exibido em cada variável. Use o id como template_id na criação do flow.



## OpenAPI

````yaml /openapi.json get /v1/message-templates
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública para consultar dados de CRM, compras e automação de uma
    organização Bevits e criar automações como rascunho para revisão e ativação.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
paths:
  /v1/message-templates:
    get:
      tags:
        - Automações
      summary: Listar templates de mensagem
      description: >-
        Lista os templates de WhatsApp (oficial e não oficial), e-mail e SMS que
        um flow pode enviar, com prévia do texto, status de aprovação do
        WhatsApp e o dado do cliente exibido em cada variável. Use o id como
        template_id na criação do flow.
      operationId: listMessageTemplates
      parameters:
        - $ref: '#/components/parameters/MessageTemplateChannel'
      responses:
        '200':
          $ref: '#/components/responses/MessageTemplateList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    MessageTemplateChannel:
      name: channel
      in: query
      description: Filtra os templates por canal.
      schema:
        type: string
        enum:
          - whatsapp
          - whatsapp_unofficial
          - email
          - sms
  responses:
    MessageTemplateList:
      description: Templates de mensagem disponíveis para flows.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageTemplateList'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ValidationError:
      description: Um parâmetro não passou pela validação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: validation_error
              message: Invalid query parameters.
              param: limit
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Erro inesperado no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    MessageTemplateList:
      type: object
      required:
        - object
        - data
        - has_more
      properties:
        object:
          type: string
          const: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/MessageTemplate'
        has_more:
          type: boolean
          const: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos até uma nova tentativa.
    MessageTemplate:
      type: object
      required:
        - object
        - id
        - channel
        - name
        - variables
      properties:
        object:
          type: string
          const: message_template
        id:
          type: string
          pattern: ^(wtp|etp|stp)_[A-Za-z0-9_-]+$
          description: >-
            Use como template_id na criação do flow: wtp_ para WhatsApp, etp_
            para e-mail e stp_ para SMS.
        channel:
          type: string
          enum:
            - whatsapp
            - whatsapp_unofficial
            - email
            - sms
        name:
          type: string
        status:
          type: string
          description: >-
            Status de aprovação do WhatsApp: approved, pending, rejected, draft
            ou paused.
        preview:
          type: string
          description: Início do texto do template.
        variables:
          type: array
          description: Variáveis do template e o dado do cliente que cada uma exibe.
          items:
            type: object
            required:
              - placeholder
              - source
            properties:
              placeholder:
                type: string
                example: '{{1}}'
              source:
                type: string
                example: first_name
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        message:
          type: string
        param:
          type: string
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  headers:
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````

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