Sign in

v1

latestOpenAPI 3.0.02026-07-26626596.3 KB
Negócios

Buscar negócios

get/api/v1/businesses

Query parameters

skipnumber
takenumber
searchstring
lossReasonstring

ID de motivo de perda.

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

tagsstring

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
productsstring

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
attendantsstring[]

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.
fieldsstring

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.
statusstring

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
businessFieldsstring

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.
sourcestring

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

minValuenumber

Valor mínimo dos negócios a serem filtrado

maxValuenumber

Valor máximo dos negócios a serem filtrado

startDatestring 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

endDatestring 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

createdAtGreaterOrEqualstring 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

createdAtLessOrEqualstring 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

lastMovedAfterstring 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

lastMovedBeforestring 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

{
  "lossReason": "59e77f5f-7581-4f20-a05b-97cd33485019",
  "tags": "every 849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896",
  "products": "none 849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896",
  "fields": "6f236135-0c72-40d2-9ff5-18c983aeb02b contains texto do campo",
  "status": "Este campo aceita uma string referente ao status",
  "businessFields": "6f236135-0c72-40d2-9ff5-18c983aeb02b contains texto do campo",
  "source": "Google Ads",
  "startDate": "2025-10-09T03%3A00%3A00.000Z",
  "endDate": "2025-02-11T03%3A00%3A00.000Z",
  "createdAtGreaterOrEqual": "2025-07-29T03%3A00%3A00.000Z",
  "createdAtLessOrEqual": "2025-03-15T03%3A00%3A00.000Z",
  "lastMovedAfter": "2025-07-22T03%3A00%3A00.000Z",
  "lastMovedBefore": "2025-12-01T03%3A00%3A00.000Z"
}

Response

countnumber required

Example response

{
  "count": 100,
  "data": [
    {
      "id": "e9a09677-cf00-4d84-aa12-6d78d6786555",
      "createdAt": "2025-06-18T22:18:36.666Z",
      "stageId": "e6803a51-4bd6-416b-b516-3622ff256732",
      "leadId": "c1152508-fdfd-4905-a3f4-f3850cc00bf0",
      "attendantId": "7e7da46a-a0ed-43c2-a3aa-3ac253f41b4d",
      "nextActivityId": "3d3d23a-a0ed-43c2-a3aa-3ac23433f41g01",
      "discount": 500,
      "shipping": 2000,
      "coupon": "CUPOM100",
      "shippingType": "Sedex",
      "status": "in_process",
      "code": 50607,
      "externalId": "f33420908-dcdc-4905-a3f4-f3850cc43bf0",
      "lastMovedAt": "2025-06-18T22:18:36.611Z",
      "statusChangedAt": "2025-06-18T22:20:14.611Z4",
      "products": [],
      "lossReasonId": "null",
      "productsCount": 2
    }
  ]
}