---
title: "Listar"
method: GET
path: "/v1/chatbot"
tags: ["Chatbots"]
---

# Listar

`GET /v1/chatbot`

Listagem de chatbots.

## Query parameters

- `Name` string
- `Types` string[]
- `ChannelIds` string[]
- `DefaultDepartmentIds` string[]
- `PublishStatuses` string[]
- `AutomationUsages` 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

- PublicChatbotDTOPublicPageListDTO
  - `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` PublicChatbotDTO[], nullable
    - `id` string, uuid
    - `key` string, uuid
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `companyId` string, uuid
    - `archived` boolean
    - `name` string, nullable
    - `type` 'Reactive' | 'Automation'
    - `channelIds` string[], nullable
    - `defaultDepartmentId` string, uuid, nullable
    - `publishStatus` 'NOT_PUBLISHED' | 'PUBLISHING' | 'READY' | 'FAILED', nullable
    - `automationUsage` 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)