---
title: "Listar"
method: GET
path: "/v1/template"
tags: ["Modelos de Mensagem"]
---

# Listar

`GET /v1/template`

Listagem paginada de modelos de mensagem.

## Query parameters

- `Archived` boolean
- `Name` string
- `SearchableText` string
- `ChannelId` string, uuid
- `ApprovedOnly` boolean
- `Type` 'QUICKREPLY' | 'ATTENDANCE' | 'CAMPAIGN' | 'SEQUENCE' | 'SCHEDULEDMESSAGE' | 'AUTHENTICATION'
- `IncludeDetails` string[]
- `CreatedAt.Before` string, date-time
- `CreatedAt.After` string, date-time
- `UpdatedAt.Before` string, date-time
- `UpdatedAt.After` string, date-time
- `PageNumber` integer
- `PageSize` integer
- `OrderBy` string
- `OrderDirection` 'ASCENDING' | 'DESCENDING'

## Response `200`

Success

- PublicTemplateDTOPublicPageListDTO
  - `pageNumber` integer — Número da página a ser obtida.
  - `pageSize` integer — Tamanho da página a ser obtida.
  - `orderBy` string, nullable — Nome do campo para ser utilizado como pivô da ordenação.
  - `orderDirection` 'ASCENDING' | 'DESCENDING', nullable — Determina se a ordenação deve ser crescente ou decrescente.
  - `items` PublicTemplateDTO[], nullable
    - `id` string, uuid
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `active` boolean
    - `archived` boolean
    - `channelId` string, uuid, nullable
    - `name` string, nullable
    - `text` string, nullable
    - `footerText` string, nullable
    - `status` 'Draft' | 'Approved' | 'Disapproved' | 'InRevision' | 'Paused' | 'Disabled' | 'Deleted'
    - `channelType` 'GUPSHUP_WHATSAPP' | 'DIALOG360_WHATSAPP' | 'CLOUDAPI_WHATSAPP' | 'ZAPI_WHATSAPP' | 'EVOLUTIONAPI_WHATSAPP' | 'INSTAGRAM' | 'MESSENGER', nullable
    - `type` string[]
    - `params` PublicTemplateParamDTO[], nullable
      - `name` string, nullable
      - `templateId` string, uuid
    - `internalName` string, nullable
    - `fileType` 'UNDEFINED' | 'IMAGE' | 'VIDEO' | 'DOCUMENT', nullable
    - `quickReplyAlias` string, nullable
    - `rejectedDescription` string, nullable
    - `categoryId` string, uuid, nullable
    - `categoryName` string, nullable
  - `totalItems` integer
  - `totalPages` integer
  - `hasMorePages` boolean

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/revisions/811b2cdd2ec2/schema)