> ## Documentation Index > Fetch the complete documentation index at: https://docs.liderhub.ai/llms.txt > Use this file to discover all available pages before exploring further. # Listar templates > Lista mensagens rápidas (templates) do workspace. Filtros: type, status Meta, paginação. Para envio use `POST /v1/send/template`. ## OpenAPI ````yaml /openapi/liderhub.json get /v1/templates openapi: 3.0.0 info: title: API Liderhub description: >- API REST para gerenciamento de conversas WhatsApp com IA. ## Autenticação A autenticação é obrigatória e deve ser feita utilizando o header `x-company-key`, gerado diretamente na plataforma Liderhub. Cada workspace possui uma chave própria, garantindo isolamento e segurança. ## Recursos disponíveis | Recurso | Descrição | |---------|-----------| | **Connections** | Gerenciar conexões WhatsApp do workspace | | **Contacts** | Listar, buscar, cadastrar contatos e marcar como lidos | | **Message** | Listar, buscar, enviar e cancelar mensagens agendadas | | **Agents** | Listar agentes de IA configurados | | **Users** | Listar usuários do workspace | | **Settings** | Consultar e atribuir status, origens, tags e departamentos aos chats | | **Groups** | Grupos WhatsApp: listar, detalhar, criar, atualizar nome/foto/configurações e gerenciar participantes e admins | | **Templates** | Listar, obter e enviar mensagens rápidas (templates) | ## Paginação Endpoints que retornam listas suportam paginação: - `page`: número da página (inicia em 1) - `limit`: itens por página (máximo 100) Retorno inclui metadados em `pagination`: page, limit, total, totalPages, hasNextPage, hasPreviousPage ## Filtros de lista (GET /v1/contacts) | Filtro | Tipo | Descrição | |--------|------|-----------| | `number` | string | Filtrar por número de telefone | | `connection` | UUID | Filtrar por conexão | | `id` | UUID | Filtrar por chat/contato — no máximo um resultado | | `department` | UUID | Filtrar por departamento | | `tags` | UUID | Filtrar por tag(s) - separar por vírgula | | `status` | UUID | Filtrar por status | | `stage` | enum | Filtrar por estágio: Open, Closed, Pending | | `hasUnread` | boolean | Filtrar contacts com mensagens não lidas | | `createdAfter` | ISO8601 | Criados após data | | `createdBefore` | ISO8601 | Criados antes de data | | `modifiedAfter` | ISO8601 | Modificados após data | | `modifiedBefore` | ISO8601 | Modificados antes de data | ⚠️ **Importante**: Utilize esta API de maneira responsável. Não forneça a credencial para terceiros. version: 1.0.0 contact: {} servers: - url: https://api.liderhub.com.br description: Produção security: [] tags: - name: Connections description: Gerenciar conexões WhatsApp do workspace - name: Contacts description: 'Contatos/conversas: listar e filtrar contatos.' - name: Message description: Listar, buscar, enviar e cancelar mensagens agendadas - name: Agents description: Listar agentes de IA configurados - name: Users description: Listar usuários do workspace - name: Settings description: Consultar e atribuir status, origens, tags e departamentos aos chats - name: Groups description: Gestão de grupos WhatsApp - name: Templates description: Templates / mensagens rápidas paths: /v1/templates: get: tags: - Templates summary: Listar templates description: >- Lista mensagens rápidas (templates) do workspace. Filtros: type, status Meta, paginação. Para envio use `POST /v1/send/template`. operationId: TemplateController_findAll parameters: - name: type required: false in: query description: Filtrar por tipo da mensagem rápida schema: type: string enum: - conversation - imageMessage - videoMessage - audioMessage - documentMessage - button - name: status required: false in: query description: Filtrar pelo status Meta em metadata (APPROVED, PENDING, REJECTED) schema: type: string enum: - APPROVED - PENDING - REJECTED - name: page required: false in: query description: 'Página (padrão: 1)' schema: type: number example: 1 - name: limit required: false in: query description: 'Itens por página (padrão: 20, máximo: 100)' schema: type: number example: 20 responses: '200': description: Lista de templates content: application/json: schema: $ref: '#/components/schemas/TemplatesListResponseDto' '401': description: Não autorizado — chave de empresa inválida ou ausente security: - x-company-key: [] components: schemas: TemplatesListResponseDto: type: object properties: templates: type: array items: $ref: '#/components/schemas/TemplateResponseDto' pagination: $ref: '#/components/schemas/TemplatesPaginationDto' required: - templates - pagination TemplateResponseDto: type: object properties: id: type: string format: uuid type: type: string enum: - conversation - imageMessage - videoMessage - audioMessage - documentMessage - button nullable: true trigger: type: string nullable: true description: Atalho / trigger no chat content: type: string nullable: true caption: type: string nullable: true fileUrl: type: string nullable: true description: URL da mídia fileName: type: string nullable: true metaName: type: string nullable: true description: Nome do template na Meta (WABA) metaStatus: type: string nullable: true description: Status Meta derivado do primeiro item de metadata enum: - APPROVED - PENDING - REJECTED hasVariables: type: boolean description: Se content/caption contém placeholders {{…}} variableCount: type: number description: Quantidade de placeholders (mapeados para var1..varN) metaComponents: type: object nullable: true description: Componentes de botão (quando type=button) additionalProperties: true metadata: description: Metadados Meta por WABA (detalhe) type: array items: $ref: '#/components/schemas/TemplateMetadataItemDto' required: - id - hasVariables - variableCount TemplatesPaginationDto: type: object properties: page: type: number example: 1 limit: type: number example: 20 total: type: number example: 100 totalPages: type: number example: 5 hasNextPage: type: boolean example: true hasPreviousPage: type: boolean example: false required: - page - limit - total - totalPages - hasNextPage - hasPreviousPage TemplateMetadataItemDto: type: object properties: status: type: string description: Status Meta example: APPROVED category: type: string description: Categoria Meta example: MARKETING language: type: string description: Idioma example: pt_BR waba: type: string description: WABA id id: type: string description: Template id na Meta securitySchemes: x-company-key: type: apiKey in: header name: x-company-key description: Chave de autenticação do workspace (gerada na plataforma Liderhub) ````