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

# Buscar conversas



## OpenAPI

````yaml https://api.datacrazy.io/v1/api/openapi/v1/json get /api/v1/conversations
openapi: 3.0.0
info:
  title: API CRM Datacrazy
  description: Versão 1.0 da API do CRM Datacrazy
  version: '1.0'
  contact: {}
servers:
  - url: https://api.g1.datacrazy.io
security: []
tags: []
paths:
  /api/v1/conversations:
    get:
      tags:
        - Conversas
      summary: Buscar conversas
      operationId: ConversationsV1Controller_getAll
      parameters:
        - name: skip
          required: false
          in: query
          schema:
            type: number
        - name: take
          required: false
          in: query
          schema:
            type: number
        - name: search
          required: false
          in: query
          schema:
            type: string
        - name: filter
          required: false
          in: query
          schema:
            $ref: '#/components/schemas/ConversationFiltersDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponseDto'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/ConversationDto'
      security:
        - access-token: []
components:
  schemas:
    ConversationFiltersDto:
      type: object
      properties:
        opened:
          type: boolean
          example: true
          description: >-
            Valor booleano para conversas em aberto. Por padrão o valor é true,
            caso o valor seja false retorna todas as conversas (incluindo
            finalizadas)
        departments:
          type: string
          example: e3581d38-aeab-483a-8275-de32dce2388a
          description: |-
            ID ou Lista de IDs de departamentos.

            Este campo aceita um único ou uma lista de IDs separados por vírgula
        instances:
          type: string
          example: 682f0a3823f2d4e36a2150c0,6808667d911e4c8975bc5405
          description: |-
            ID ou Lista de IDs de instâncias.

            Este campo aceita um único ou uma lista de IDs separados por vírgula
        tags:
          type: string
          example: >-
            849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896
          description: >-
            ID ou lista de IDs de tags.


            Este campo aceita um ID ou uma lista de IDs de tags separados por
            vírgula
        stages:
          type: string
          example: >-
            849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896
          description: |-
            ID do stage.

            Este campo aceita um únido ID, referente a um estágio de pipeline
        attendants:
          type: string
          example: >-
            849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896
          description: |-
            ID ou Lista de IDs de atendentes.

            Este campo aceita um único ou uma lista de IDs separados por vírgula
        openWindow:
          type: string
          example: last24h
          description: >-
            Filtro de janela em aberto.


            Valores aceitos: 'last24h' (mensagens recebidas nas últimas 24
            horas) ou 'all' (todas as conversas)
          enum:
            - last24h
            - all
    PaginatedResponseDto:
      type: object
      properties:
        count:
          type: number
          example: 100
      required:
        - count
    ConversationDto:
      type: object
      properties:
        id:
          type: string
          example: 6808cd89c9968a7b8a41b9f7
          description: ID da conversa
        createdAt:
          format: date-time
          type: string
          example: '2025-04-23T11:22:49.143Z'
          description: Data de início da conversa
        updatedAt:
          format: date-time
          type: string
          example: '2025-06-24T16:28:23.722Z'
          description: Data da última atualização da conversa
        deletedAt:
          format: date-time
          type: string
          example: '2025-12-24T16:31:59.531Z'
          description: Data de exclusão da conversa
        archivedAt:
          format: date-time
          type: string
          example: '2025-12-24T16:31:59.531Z'
          description: Data de ocultação da conversa
        name:
          type: string
          example: Patrick Almeida
          description: Nome do lead da conversa
        description:
          type: string
          example: Cliente solicitou contato para o mês de novembro
          description: Descrição atribuída a conversa
        imageURL:
          type: string
          example: >-
            https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/df4db2b8-7f0f-44d4-88e1-dd3e838f275e
          description: Url da imagem do contato
        isGroup:
          type: boolean
          example: true
          description: Valor boleano que indica se a conversa é com um grupo ou não
        automationEnabled:
          type: boolean
          example: true
          description: >-
            Valor boleano que indica se as automações estão habilitadas para
            essa conversa
        contact:
          description: Informações do contato da conversa
          example:
            id: '554799970654'
            createdAt: '2024-12-19T14:21:42.164Z'
            updatedAt: '2025-06-24T16:28:23.703Z'
            name: Angelica Schramm
            imageURL: >-
              https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/df4db2b8-7f0f-44d4-88e1-dd3e838f275e
            contactId: '5547988367066'
            platform: WHATSAPP
            externalId: 1c3627f8-d6b9-42a9-b355-6977c04c969e
            accountName: '@AngelicaSchramm'
            pending: true
            externalInfo:
              tagIds: >-
                849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896
              stageIds: >-
                6fda2a0d-5e7c-4c51-bf47-2c60f7d34283,2bc3d979-93a4-4e64-8903-5d9379d3de91
              pipelineIds: >-
                3e409b29-0462-40b0-aef4-5eb6f0f2f89a,74c8e833-f681-4ed0-9ce6-e474e2d4b1a0
          allOf:
            - $ref: '#/components/schemas/ContactDto'
        instance:
          description: Informações do contato da conversa
          allOf:
            - $ref: '#/components/schemas/InstanceDto'
        attendants:
          description: ID ou lista de IDs referentes ao atendente da conversa
          example:
            - id: 67632a6713d401dff6bf8672
          type: array
          items:
            type: string
        lastMessageDate:
          format: date-time
          type: string
          example: '2025-06-23T21:18:59.068Z'
          description: Data da última mensagem da conversa, recebida ou enviada
        lastReceivedMessageDate:
          format: date-time
          type: string
          example: '2025-06-23T21:18:59.068Z'
          description: Data da última mensagem recebida na conversa
        lastSendedMessageDate:
          format: date-time
          type: string
          example: '2025-11-22T21:20:15.733Z'
          description: Data da última mensagem enviada na conversa
        currentDepartment:
          description: Departamento em que a conversa está
          example:
            id: 6804203784ea2133a1e25bd0
            tenantId: d9bd689a-bb7e-4552-b7f6-c7f7b8b73b2b
            createdAt: '2025-04-19T22:14:15.964Z'
            name: Pós-vendas
            color: '#FF2200'
            main: true
            updatedAt: '2025-04-19T22:14:15.998Z'
          allOf:
            - $ref: '#/components/schemas/DepartmentDto'
        currentThread:
          description: Thread referente a conversa
          example:
            id: ID da thread
            code: Código da thread
            startedAt: Data de início da thread
            finishedAt: Data de finalização da thread
            attendants:
              - <string>
            conversationId: ID da conversation
            department:
              id: 6804203784ea2133a1e25bd0
            durationInMs: Duraçao em milisegundos na thread
            waitTimeInMs: Tempo de espera em milisegundos na thread
          allOf:
            - $ref: '#/components/schemas/ThreadDto'
        hidden:
          type: boolean
          example: 'false'
        finished:
          type: boolean
          example: true
          description: Valor boleano que indica se a conversa está finalizada
        isPending:
          type: boolean
          example: false
          description: Valor boleano que indica se a conversa possui mensagens pendentes
        sourceReferral:
          description: >-
            Dados que indicam como um cliente chegou a iniciar uma conversa com
            sua empresa através de um anúncio
          example:
            sourceId: 2bc3d979-93a4-4e64-8903-5d9379d3de91
            sourceUrl: https://example.com/artigo-de-origem
            ctwaId: 849fefab-e697-4720-9303-e788c23790cc
          allOf:
            - $ref: '#/components/schemas/SourceReferralDto'
        lastMessageIsAutomation:
          type: boolean
          example: true
          description: >-
            Valor boleano que indica se a ultima mensagem enviada naquela
            conversa foi por uma automação
    ContactDto:
      type: object
      properties:
        id:
          type: string
          description: ID do contato
          example: 6808cd89c9968a7b8a41b9f7
        createdAt:
          format: date-time
          type: string
          example: '2024-12-19T14:21:42.164Z'
          description: Data de criação do contato
        updatedAt:
          format: date-time
          type: string
          example: '2025-06-24T16:28:23.703Z'
          description: Data de atualização do contato
        name:
          type: string
          example: Angelica Schramm
          description: Nome do contato salvo no Data Crazy
        imageURL:
          type: string
          example: >-
            https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/df4db2b8-7f0f-44d4-88e1-dd3e838f275e
          description: URL da imagem de perfil do contato
        contactId:
          type: string
          example: '5547988367066'
          description: ID do contato
        platform:
          type: string
          example: WHATSAPP
          description: Plataforma utilizada no contato
        externalId:
          type: string
          example: 1c3627f8-d6b9-42a9-b355-6977c04c969e
          description: ID exterdo do contato
        accountName:
          type: string
          example: '@AngelicaSchramm'
          description: >-
            Nome do usuário na plataforma de contato, por exemplo nome no
            Instagram
        pending:
          type: boolean
          example: true
          description: Valor boleano que indica se a mensagem ainda está pendente de envio
        externalInfo:
          description: Informações externas de alguma fonte de dados
          allOf:
            - $ref: '#/components/schemas/ContactExternalInfoDto'
    InstanceDto:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da instância
          example: 507f1f77bcf86cd799439011
        name:
          type: string
          description: Nome da instância
          example: Instância atendimentos suporte
        createdAt:
          format: date-time
          type: string
          description: Data de criação da instância
          example: '2024-04-11T12:00:00.000Z'
        updatedAt:
          format: date-time
          type: string
          description: Data de atualização da instância
          example: '2024-04-11T14:30:00.000Z'
        platform:
          type: string
          description: Platforma da instância
          example: WHATSAPP
        provider:
          type: string
          description: Provedor da integração
          example: WHATSAPP_CLOUD_API
        engine:
          type: string
          description: Motor da instância
          example: WHATSAPP_CLOUD_API_19
        config:
          type: object
          description: Configurações adicionais da instância
          example:
            endAutomationInterval: 15
            endTypingInterval: 1
            evolutionApiUrl: https://evolution-evolution2.mcmoxg.easypanel.host
            evolutionInstanceId: Instancia suporte
            evolutionInstanceToken: 78523FD522AA-97KD-8C0F-8138D5A84671
            listenGroups: false
            typeList: buttons
            startAutomationInterval: 3
            startTypingInterval: 0
            typingInterval: false
        isActive:
          type: boolean
          description: Indica se a instância está ativa
          example: true
        webhook:
          type: string
          description: Path do webhook
          example: >-
            /webhooks/z-api/d129a692-e5ab-42b3-b0e4-90ad9a12b068/68597f2a95fb0298e5c128b5
        status:
          type: string
          description: Status da conexão
          example: CONNECTED
        errorCode:
          type: string
          description: Código de erro da conexão com a instância
          example: '429'
        errorMessage:
          type: string
          description: Mensagem de erro da conexão com a instância
          example: Não foi possível se conectar com o provedor
        deletedAt:
          format: date-time
          type: string
          description: Data de exclusão da instância
          example: '2025-11-07T22:05:15.754Z'
    DepartmentDto:
      type: object
      properties:
        id:
          type: string
          description: ID do departamento
          example: 6804203784ea2133a1e25bd0
        tenantId:
          type: string
          description: ID da empresa na qual a conversa está
          example: d9bd689a-bb7e-4552-b7f6-c7f7b8b73b2b
        createdAt:
          type: string
          description: Data de criação do departamento
          example: '2025-04-19T22:14:15.964Z'
        name:
          type: string
          description: Nome do departamento
          example: Pós-vendas
        color:
          type: string
          description: Cor do departamento em formato hexadecimal
          example: '#FF2200'
        main:
          type: boolean
          description: >-
            Valor boleano que indica se o departamento é o departamento
            principal da empresa
          example: true
        updatedAt:
          type: string
          description: Data de atualização do departamento
          example: '2025-04-19T22:14:15.998Z'
    ThreadDto:
      type: object
      properties:
        id:
          type: string
          example: ID da thread
          description: 680fd3377b1a71ca8844f899
        code:
          type: number
          example: 115
          description: Código da thread
        startedAt:
          format: date-time
          type: string
          description: Data de início na thread
          example: '2025-06-23T21:18:59.042Z'
        finishedAt:
          format: date-time
          type: string
          description: Data de finalização da thread
          example: '2025-12-28T21:12:59.0631Z'
        attendants:
          description: Atendentes na thread
          type: array
          items:
            type: string
        conversationId:
          type: string
          example: ID da conversation
          description: 6808cd89c9968a7b8a41b9f7
        conversation:
          $ref: '#/components/schemas/ConversationDto'
        department:
          description: 3e409b29-0462-40b0-aef4-5eb6f0f2f89a
          allOf:
            - $ref: '#/components/schemas/DepartmentDto'
        durationInMs:
          type: number
          description: Duração em milisegundos na thread
          example: '6412432'
        waitTimeInMs:
          type: number
          description: Tempo de espera em milisegundos na thread
          example: '4845963'
    SourceReferralDto:
      type: object
      properties:
        sourceId:
          type: string
          description: ID referente fonte
          example: 2bc3d979-93a4-4e64-8903-5d9379d3de91
        sourceUrl:
          type: string
          description: Url referente fonte
          example: https://example.com/artigo-de-origem
        ctwaId:
          type: string
          description: CTWA referente (Click to WhatsApp ID)
          example: 849fefab-e697-4720-9303-e788c23790cc
    ContactExternalInfoDto:
      type: object
      properties:
        tagIds:
          example:
            - 849fefab-e697-4720-9303-e788c23790cc
            - 9e008d34-86d2-49fd-90af-34a9f9b29896
          description: Lista de ID de tags recebida da fonte de dados
          type: array
          items:
            type: string
        stageIds:
          example:
            - 6fda2a0d-5e7c-4c51-bf47-2c60f7d34283
            - 2bc3d979-93a4-4e64-8903-5d9379d3de91
          description: Lista de ID de stages recebida da fonte de dados
          type: array
          items:
            type: string
        pipelineIds:
          example:
            - 3e409b29-0462-40b0-aef4-5eb6f0f2f89a
            - 74c8e833-f681-4ed0-9ce6-e474e2d4b1a0
          description: Lista de ID de stages recebida da fonte de dados
          type: array
          items:
            type: string
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http

````