---
title: "Listar"
method: GET
path: "/v1/company"
tags: ["Contas"]
---

# Listar

`GET /v1/company`

Para autenticar nos endpoints de Gestão de Contas, utilize o Token de Parceiro.<br />O token pode ser gerado na plataforma em `Admin > Personalizar > Integração`.<br />Envie-o no header `Authorization` com o schema `Bearer`.<br />Este token é exclusivo para os endpoints de Gestão de Contas e Parceiros.
<br /><br />Listagem paginada de contas.

## Query parameters

- `SearchableText` string
- `OnlyInactive` boolean
- `Status` 'SANDBOX' | 'PRODUCTION'
- `SetupStatus` 'SUBSCRIPTION_PENDING' | 'SUBSCRIPTION_CREATED' | 'PENDING_CONFIG' | 'COMPLETED' | 'SUBSCRIPTION_ARREARS' | 'SUBSCRIPTION_SUSPENDED' | 'SUBSCRIPTION_CANCELED'
- `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

- PublicCompanyDTOPublicPageListDTO
  - `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` PublicCompanyDTO[], nullable
    - `id` string, uuid — Identificador único da conta
    - `createdAt` string, date-time — Data de criação da conta
    - `updatedAt` string, date-time — Data da última atualização da conta
    - `active` boolean — Indica se a conta está ativa
    - `legalName` string, nullable — Razão social da empresa
    - `documentType` 'CPF' | 'CNPJ' — Tipo de documento (CPF ou CNPJ)
    - `documentId` string, nullable — Número do documento (CPF ou CNPJ)
    - `name` string, nullable — Nome fantasia da empresa
    - `partnerName` string, nullable — Nome do parceiro associado à conta
    - `ownerId` string, uuid, nullable — ID do proprietário da conta
    - `category` string, nullable — Categoria da empresa
    - `customCategory` string, nullable — Categoria personalizada da empresa
    - `type` 'UNDEFINED' | 'MEI' | 'LIMITED' | 'INDIVIDUAL' | 'ASSOCIATION' — Tipo da conta
    - `invoiceType` 'HELENA' | 'DIALOG360' — Tipo de faturamento
    - `partnerId` string, uuid, nullable — ID do parceiro
    - `pictureUrl` string, nullable — URL da imagem de perfil
    - `wppNumber` string, nullable — Número de WhatsApp
    - `phoneNumber` string, nullable — Número de telefone
    - `phoneNumberFormatted` string, nullable — Número de telefone formatado
    - `email` string, nullable — Email de contato
    - `defaultDepartmentId` string, uuid, nullable — ID da equipe padrão
    - `address` PublicAddressDataDTO — DTO representando um endereço
      - `country` string, nullable — País
      - `state` string, nullable — Estado
      - `city` string, nullable — Cidade
      - `neighborhood` string, nullable — Bairro
      - `zipcode` string, nullable — CEP
      - `number` string, nullable — Número
      - `address1` string, nullable — Logradouro
      - `address2` string, nullable — Complemento
    - `setupStatus` 'DEMO' | 'ONBOARDING' | 'PRODUCTION' | 'DELAYED' | 'SUSPENDED' | 'CANCELED' — Status de configuração da conta
    - `config` PublicCompanyConfigDTO — Configurações da conta
      - `planName` string, nullable — Nome do plano
      - `campaignEnabled` boolean — Campanhas habilitadas
      - `panelEnabled` boolean — Painéis habilitados
      - `customFieldEnabled` boolean — Campos personalizados habilitados
      - `webhookEnabled` boolean — Webhooks habilitados
      - `advancedChatbotEnabled` boolean — Chatbots avançados habilitados
      - `resources` PublicCompanyResourcesDTO — Recursos incluídos no plano da conta
        - `includedSessions` integer, nullable — Quantidade de sessões incluídas
        - `includedAgents` integer, nullable — Quantidade de agentes incluídos
        - `includedPanels` integer, nullable — Quantidade de painéis incluídos
        - `includedChatbots` integer, nullable — Quantidade de chatbots incluídos
        - `includedChatbotAutomations` integer, nullable — Quantidade de automações de chatbot incluídas
        - `includedWhatsAppChannels` integer, nullable — Quantidade de canais de WhatsApp incluídos
        - `includedInstagramChannels` integer, nullable — Quantidade de canais do Instagram incluídos
        - `includedMessengerChannels` integer, nullable — Quantidade de canais do Messenger incluídos
        - `includedSequences` integer, nullable — Quantidade de sequências incluídas
  - `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)