> ## 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 negócios



## OpenAPI

````yaml https://api.datacrazy.io/v1/api/openapi/v1/json get /api/v1/businesses
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/businesses:
    get:
      tags:
        - Negócios
      summary: Buscar negócios
      operationId: BusinessesV1Controller_get
      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/BusinessesFiltersDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponseDto'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/BusinessDto'
      security:
        - access-token: []
components:
  schemas:
    BusinessesFiltersDto:
      type: object
      properties:
        lossReason:
          type: string
          example: 59e77f5f-7581-4f20-a05b-97cd33485019
          description: |-
            ID de motivo de perda.

            Este campo aceita um ID de motivo de perda do negócio.
        tags:
          type: string
          example: >-
            every
            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, com uma operação opcional definida no início da string.


            Formato:

            `<operação> <id1>,<operação> <id2>,<operação> <id3>`


            Operação (opcional): define como os IDs serão interpretados, caso
            seja omitido a operação padrão é some. Pode ser:

            - `some` – pelo menos uma das tags

            - `every` – todas as tags

            - `none` – nenhuma das tags
        products:
          type: string
          example: >-
            none
            849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896
          description: >-
            ID ou lista de IDs de produtos.


            Este campo aceita um ID ou lista de IDs separados por vírgula, com
            uma operação opcional definida no início da string.


            Formato:

            `<operação> <id1>,<operação> <id2>,<operação> <id3>`


            Operação (opcional): define como os IDs serão interpretados, caso
            seja omitido a operação padrão é some. Pode ser:

            - `some` – pelo menos um dos produtos

            - `every` – todos os produtos

            - `none` – nenhum dos produtos
        attendants:
          example: >-
            9e008d34-86d2-49fd-90af-34a9f9b29896,849fefab-e697-4720-9303-e788c23790cc
          description: |-
            ID ou lista de IDs de atendentes.

            Formato:
            `<ID>,<ID1>,<ID2>`

            Detalhes:
            - Este campo aceita um ID ou uma lista de IDs separados por vírgula.
          type: array
          items:
            type: string
        fields:
          type: string
          example: 6f236135-0c72-40d2-9ff5-18c983aeb02b contains texto do campo
          description: |-
            Expressões de filtro em campos adicionais do lead.

            Formato:
            `<idDoCampo> <operação> <valorDoCampo>`

            Parâmetros:
            - `idDoCampo`: ID do campo adicional do lead.
            - `operação`: opção do filtro.
               - `contains`: campo **contém** o valor.
               - `eq`: campo **igual** ao valor.
               - `not`: campo **não contém** o valor.
            - `valorDoCampo`: conteúdo do campo adicional do lead.
        status:
          type: string
          example: Este campo aceita uma string referente ao status
          description: |-
            Este campo aceita uma string contendo algum dos status de negócio.

            Campos de status disponíveis:
            - `won` - negócios ganhos
            - `in_process` - negócios em aberto
            - `lost` - negócios perdidos
        businessFields:
          type: string
          example: 6f236135-0c72-40d2-9ff5-18c983aeb02b contains texto do campo
          description: |-
            Expressões de filtro em campos adicionais do negócio.

            Formato:
            `<idDoCampo> <operação> <valorDoCampo>`

            - `idDoCampo`: ID do campo adicional do negócio.
            - `operação`: opção do filtro. Operações disponíveis:
              - `contains`: campo contém o valor.
              - `eq`: campo igual ao valor.
              - `not`: campo não contém o valor.
            - `valorDoCampo`: conteúdo do campo adicional.
        source:
          type: string
          example: Google Ads
          description: >-
            Este campo aceita uma string contendo a origem do lead, todos os
            negócios do lead com a origem filtrada serão retornados
        minValue:
          type: number
          example: '12000'
          description: Valor mínimo dos negócios a serem filtrado
        maxValue:
          type: number
          example: '300'
          description: Valor máximo dos negócios a serem filtrado
        startDate:
          format: date-time
          type: string
          example: 2025-10-09T03%3A00%3A00.000Z
          description: >-
            Filtro de intervalo, negócios que estão em negociação ou estavam em
            negociação em determinado intervalo. Formato (ISO 8601):
            `YYYY-MM-DDTHH:mm:ss.sssZ`
        endDate:
          format: date-time
          type: string
          example: 2025-02-11T03%3A00%3A00.000Z
          description: >-
            Filtro de intervalo, negócios que estão em negociação ou estavam em
            negociação em determinado intervalo Formato (ISO 8601):
            `YYYY-MM-DDTHH:mm:ss.sssZ`
        createdAtGreaterOrEqual:
          format: date-time
          type: string
          example: 2025-07-29T03%3A00%3A00.000Z
          description: >-
            Negócios criados na data posterior (mais recentes) a informada ou na
            mesma data. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ`
        createdAtLessOrEqual:
          format: date-time
          type: string
          example: 2025-03-15T03%3A00%3A00.000Z
          description: >-
            Negócios criados na data anterior (mais antigos) a informada ou na
            mesma data. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ`
        lastMovedAfter:
          format: date-time
          type: string
          example: 2025-07-22T03%3A00%3A00.000Z
          description: >-
            Negócios movidos na data posterior (mais recentes) a informada ou na
            mesma data. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ`
        lastMovedBefore:
          format: date-time
          type: string
          example: 2025-12-01T03%3A00%3A00.000Z
          description: >-
            Negócios movidos na data anterior (mais antigos) a informada ou na
            mesma data. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ`
    PaginatedResponseDto:
      type: object
      properties:
        count:
          type: number
          example: 100
      required:
        - count
    BusinessDto:
      type: object
      properties:
        id:
          type: string
          example: e9a09677-cf00-4d84-aa12-6d78d6786555
          description: ID do negócio.
        createdAt:
          format: date-time
          type: string
          example: '2025-06-18T22:18:36.666Z'
          description: Data de criação do negócio.
        stageId:
          type: string
          example: e6803a51-4bd6-416b-b516-3622ff256732
          description: ID do estágio atual do negócio.
        leadId:
          type: string
          example: c1152508-fdfd-4905-a3f4-f3850cc00bf0
          description: ID do lead associado ao negócio.
        attendantId:
          type: string
          example: 7e7da46a-a0ed-43c2-a3aa-3ac253f41b4d
          description: ID do atendente responsável pelo negócio.
        nextActivityId:
          type: string
          example: 3d3d23a-a0ed-43c2-a3aa-3ac23433f41g01
          description: ID da próxima atividade relacionada ao negócio.
        total:
          type: number
          example: '70000'
          description: Valor total do negócio.
        discount:
          type: number
          example: 500
          description: Valor de desconto aplicado ao negócio.
        addition:
          type: number
          example: 0
          description: Valor de acréscimos aplicados ao negócio.
        shipping:
          type: number
          example: 2000
          description: Valor do frete relacionado ao negócio.
        coupon:
          type: string
          example: CUPOM100
          description: Cupom de desconto utilizado no negócio.
        shippingType:
          type: string
          example: Sedex
          description: Tipo de frete selecionado para o negócio.
        status:
          type: string
          example: in_process
          description: Status atual do negócio.
        code:
          type: number
          example: 50607
          description: Código interno do negócio.
        externalId:
          type: string
          example: f33420908-dcdc-4905-a3f4-f3850cc43bf0
          description: ID externo vinculado ao negócio.
        lastMovedAt:
          format: date-time
          type: string
          example: '2025-06-18T22:18:36.611Z'
          description: Data da última movimentação do negócio.
        statusChangedAt:
          format: date-time
          type: string
          example: 2025-06-18T22:20:14.611Z4
          description: Data da última alteração do status do negócio.
        products:
          example: []
          description: Lista de produtos associados ao negócio.
          type: array
          items:
            $ref: '#/components/schemas/BusinessProductDto'
        lossReasonId:
          type: string
          example: 'null'
          description: ID do motivo de perda do negócio.
        justification:
          type: string
          example: ''
          description: Justificativa associada ao negócio.
        productsCount:
          type: number
          example: 2
          description: Quantidade total de produtos no negócio.
    BusinessProductDto:
      type: object
      properties:
        id:
          type: string
          example: 8cb0e554-c0a1-4eea-af71-b4909ef8b5ec
          description: Identificador único do produto no negócio.
        product:
          description: Informações do produto associado ao negócio.
          allOf:
            - $ref: '#/components/schemas/ProductDto'
        quantity:
          type: number
          example: 1
          description: Quantidade do produto no negócio.
        price:
          type: number
          example: 70
          description: Preço unitário do produto no negócio.
        total:
          type: number
          example: 70
          description: Valor total do produto no negócio (preço x quantidade).
    ProductDto:
      type: object
      properties:
        id:
          type: string
          example: 15b41959-b04d-4a99-b878-6e45fffa7633
          description: Id do produto
        id_sku:
          type: string
          example: SKU12345
          description: Id SKU do produto
        name:
          type: string
          example: Nome do Produto
          description: Nome do produto
        price:
          type: number
          example: 199.99
          description: Preço do produto
        createdAt:
          format: date-time
          type: string
          description: Data de criação do produto
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http

````