Buscar negócios

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

skip

number

take

number

string

filter

object

Show child attributes

filter.lossReason

string

ID de motivo de perda.

Este campo aceita um ID de motivo de perda do negócio.

Example:

"59e77f5f-7581-4f20-a05b-97cd33485019"

filter.tags

string

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

Example:

"every 849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896"

filter.products

string

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

Example:

"none 849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896"

filter.attendants

string[]

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.

Example:

"9e008d34-86d2-49fd-90af-34a9f9b29896,849fefab-e697-4720-9303-e788c23790cc"

filter.fields

string

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.

Example:

"6f236135-0c72-40d2-9ff5-18c983aeb02b contains texto do campo"

filter.status

string

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

Example:

"Este campo aceita uma string referente ao status"

filter.businessFields

string

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.

Example:

"6f236135-0c72-40d2-9ff5-18c983aeb02b contains texto do campo"

filter.source

string

Este campo aceita uma string contendo a origem do lead, todos os negócios do lead com a origem filtrada serão retornados

Example:

"Google Ads"

filter.minValue

number

Valor mínimo dos negócios a serem filtrado

Example:

"12000"

filter.maxValue

number

Valor máximo dos negócios a serem filtrado

Example:

"300"

filter.startDate

string<date-time>

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

Example:

"2025-10-09T03%3A00%3A00.000Z"

filter.endDate

string<date-time>

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

Example:

"2025-02-11T03%3A00%3A00.000Z"

filter.createdAtGreaterOrEqual

string<date-time>

Negócios criados na data posterior (mais recentes) a informada ou na mesma data. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

Example:

"2025-07-29T03%3A00%3A00.000Z"

filter.createdAtLessOrEqual

string<date-time>

Negócios criados na data anterior (mais antigos) a informada ou na mesma data. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

Example:

"2025-03-15T03%3A00%3A00.000Z"

filter.lastMovedAfter

string<date-time>

Negócios movidos na data posterior (mais recentes) a informada ou na mesma data. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

Example:

"2025-07-22T03%3A00%3A00.000Z"

filter.lastMovedBefore

string<date-time>

Negócios movidos na data anterior (mais antigos) a informada ou na mesma data. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

Example:

"2025-12-01T03%3A00%3A00.000Z"

Response

200 - application/json

count

number

required

Example:

100

data

object[]

Show child attributes

data.id

string

ID do negócio.

Example:

"e9a09677-cf00-4d84-aa12-6d78d6786555"

data.createdAt

string<date-time>

Data de criação do negócio.

Example:

"2025-06-18T22:18:36.666Z"

data.stageId

string

ID do estágio atual do negócio.

Example:

"e6803a51-4bd6-416b-b516-3622ff256732"

data.leadId

string

ID do lead associado ao negócio.

Example:

"c1152508-fdfd-4905-a3f4-f3850cc00bf0"

data.attendantId

string

ID do atendente responsável pelo negócio.

Example:

"7e7da46a-a0ed-43c2-a3aa-3ac253f41b4d"

data.nextActivityId

string

ID da próxima atividade relacionada ao negócio.

Example:

"3d3d23a-a0ed-43c2-a3aa-3ac23433f41g01"

data.total

number

Valor total do negócio.

Example:

"70000"

data.discount

number

Valor de desconto aplicado ao negócio.

Example:

500

data.addition

number

Valor de acréscimos aplicados ao negócio.

Example:

0

data.shipping

number

Valor do frete relacionado ao negócio.

Example:

2000

data.coupon

string

Cupom de desconto utilizado no negócio.

Example:

"CUPOM100"

data.shippingType

string

Tipo de frete selecionado para o negócio.

Example:

"Sedex"

data.status

string

Status atual do negócio.

Example:

"in_process"

data.code

number

Código interno do negócio.

Example:

50607

data.externalId

string

ID externo vinculado ao negócio.

Example:

"f33420908-dcdc-4905-a3f4-f3850cc43bf0"

data.lastMovedAt

string<date-time>

Data da última movimentação do negócio.

Example:

"2025-06-18T22:18:36.611Z"

data.statusChangedAt

string<date-time>

Data da última alteração do status do negócio.

Example:

"2025-06-18T22:20:14.611Z4"

data.products

object[]

Lista de produtos associados ao negócio.

Show child attributes

data.products.id

string

Identificador único do produto no negócio.

Example:

"8cb0e554-c0a1-4eea-af71-b4909ef8b5ec"

data.products.product

object

Informações do produto associado ao negócio.

Show child attributes

data.products.product.id

string

Id do produto

Example:

"15b41959-b04d-4a99-b878-6e45fffa7633"

data.products.product.id_sku

string

Id SKU do produto

Example:

"SKU12345"

data.products.product.name

string

Nome do produto

Example:

"Nome do Produto"

data.products.product.price

number

Preço do produto

Example:

199.99

data.products.product.createdAt

string<date-time>

Data de criação do produto

data.products.quantity

number

Quantidade do produto no negócio.

Example:

1

data.products.price

number

Preço unitário do produto no negócio.

Example:

70

data.products.total

number

Valor total do produto no negócio (preço x quantidade).

Example:

70

Example:

[]

data.lossReasonId

string

ID do motivo de perda do negócio.

Example:

null

data.justification

string

Justificativa associada ao negócio.

Example:

""

data.productsCount

number

Quantidade total de produtos no negócio.

Example:

2

Primeiros Passos

API Reference

Authorizations

Query Parameters

Response