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

# Listar Conversas

> Retorna a lista de conversas externas da conta autenticada, com suporte a filtros por setor e responsável.

## Requisição

`GET https://crm.wavups.com/api/v1/account-external-conversation`

<ParamField header="Token" type="string" required>
  Seu token de autenticação.
</ParamField>

### Query Parameters

<ParamField query="accountChatSectorId" type="string">
  Filtra conversas pertencentes a um setor específico. Informe o ID do setor.
</ParamField>

<ParamField query="conversationOwnerId" type="string">
  Filtra conversas pelo ID do usuário responsável pela conversa.
</ParamField>

***

## Resposta

Retorna um array de objetos de conversa, ordenados do mais recente para o mais antigo. Os campos internos `accountId`, `externalId`, `externalContactId`, `platformIntegrationId` e `updatedAt` são omitidos.

<ResponseField name="id" type="string">
  Identificador único da conversa.
</ResponseField>

<ResponseField name="leadId" type="string | null">
  ID do lead vinculado à conversa.
</ResponseField>

<ResponseField name="conversationOwnerId" type="string | null">
  ID do usuário responsável pela conversa.
</ResponseField>

<ResponseField name="accountChatSectorId" type="string | null">
  ID do setor de chat ao qual a conversa pertence.
</ResponseField>

<ResponseField name="contactName" type="string">
  Nome do contato da conversa.
</ResponseField>

<ResponseField name="contactPhone" type="string | null">
  Telefone do contato.
</ResponseField>

<ResponseField name="contactUsername" type="string | null">
  Username do contato (ex: handle do Instagram).
</ResponseField>

<ResponseField name="lastMessage" type="object | null">
  Objeto JSON com os dados da última mensagem da conversa.
</ResponseField>

<ResponseField name="lastMessageAt" type="string | null">
  Data e hora da última mensagem (ISO 8601).
</ResponseField>

<ResponseField name="unreadCount" type="number">
  Quantidade de mensagens não lidas. Padrão: `0`.
</ResponseField>

<ResponseField name="status" type="string">
  Status da conversa. Padrão: `active`.
</ResponseField>

<ResponseField name="createdAt" type="string">
  Data de criação da conversa (ISO 8601).
</ResponseField>

<ResponseField name="ConversationOwner" type="object | null">
  Dados do usuário responsável pela conversa.

  <Expandable title="Propriedades do responsável">
    <ResponseField name="User" type="object | null">
      <Expandable title="Propriedades do usuário">
        <ResponseField name="name" type="string">
          Nome do usuário responsável.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="PlatformIntegration" type="object">
  Dados da integração de plataforma associada à conversa.

  <Expandable title="Propriedades da integração">
    <ResponseField name="name" type="string">
      Nome da plataforma de integração (ex: `WhatsApp`, `Instagram`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="accountLabelAssignments" type="array">
  Lista de etiquetas atribuídas à conversa.

  <Expandable title="Propriedades da etiqueta">
    <ResponseField name="AccountLabel" type="object">
      <Expandable title="Propriedades">
        <ResponseField name="id" type="string">
          Identificador único da etiqueta.
        </ResponseField>

        <ResponseField name="name" type="string">
          Nome da etiqueta.
        </ResponseField>

        <ResponseField name="color" type="string">
          Cor da etiqueta em formato hexadecimal (ex: `#FF0000`).
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

***

<RequestExample>
  ```bash GET /api/v1/account-external-conversation theme={null}
  curl --request GET \
    --url 'https://crm.wavups.com/api/v1/account-external-conversation?accountChatSectorId=csector001' \
    --header 'Token: SEU_TOKEN_DE_API'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": "clxyz123",
      "leadId": "clead456",
      "conversationOwnerId": "cuser789",
      "accountChatSectorId": "csector001",
      "contactName": "Maria Silva",
      "contactPhone": "+5511999990000",
      "contactUsername": null,
      "lastMessage": { "type": "text", "text": "Olá, tudo bem?" },
      "lastMessageAt": "2025-10-01T14:30:00.000Z",
      "unreadCount": 2,
      "status": "active",
      "createdAt": "2025-09-15T10:00:00.000Z",
      "ConversationOwner": {
        "User": {
          "name": "João Souza"
        }
      },
      "PlatformIntegration": {
        "name": "WhatsApp"
      },
      "accountLabelAssignments": [
        {
          "AccountLabel": {
            "id": "clabel001",
            "name": "Urgente",
            "color": "#FF0000"
          }
        }
      ]
    }
  ]
  ```

  ```json 500 theme={null}
  {
    "error": "Error to get external conversations"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /account-external-conversation
openapi: 3.0.3
info:
  title: WavUps CRM API
  description: >-
    API pública da plataforma WavUps CRM — gerencie leads, produtos, categorias,
    atendimentos, agendamentos, conversas e pipelines de CRM.
  version: 1.0.0
servers:
  - url: https://crm.wavups.com/api/v1
    description: Servidor de produção
security:
  - Token: []
paths:
  /account-external-conversation:
    get:
      tags:
        - Conversas
      summary: Listar Conversas
      description: >-
        Retorna a lista de conversas externas da conta autenticada, com suporte
        a filtros por setor e responsável.
      operationId: listConversations
      parameters:
        - name: accountChatSectorId
          in: query
          description: Filtra conversas pertencentes a um setor específico.
          schema:
            type: string
        - name: conversationOwnerId
          in: query
          description: Filtra conversas pelo ID do responsável.
          schema:
            type: string
      responses:
        '200':
          description: Lista de conversas retornada com sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Conversation'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    Conversation:
      type: object
      properties:
        id:
          type: string
        contactName:
          type: string
          nullable: true
        contactPhone:
          type: string
          nullable: true
        accountChatSectorId:
          type: string
          nullable: true
        conversationOwnerId:
          type: string
          nullable: true
        status:
          type: string
        createdAt:
          type: string
          format: date-time
    ErrorMessage:
      type: object
      properties:
        error:
          type: string
          example: Recurso não encontrado.
  responses:
    Error500:
      description: Erro interno no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Token
      description: Token de autenticacao gerado na plataforma WavUps CRM.

````