Listar negocios

GEThttps://api.bydomu.com/v1/deals

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Negocios de la organización con filtros y paginación por página o por cursor (pageSize máximo 500). status acepta varios valores separados por comas.

Permissão

deals:read

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Parâmetros de consulta

pageinteger

Página, desde 1 · default=1 · ≥ 1

pageSizeinteger

Negocios por página (máximo 500) · default=20 · 1–500

cursorstring

Paginación por cursor: el meta.nextCursor de la respuesta anterior

includeTotalboolean | string

false para no contar el total (más rápido)

sortBystring

Campo de orden (por defecto createdAt) · default="createdAt"

sortOrderstring

Dirección del orden ascdesc · default="desc"

searchstring

Título o código del negocio

propertyIdstring

Negocios vinculados a esta propiedad

statusstring[]

Estados, separados por comas · nullable

stageIdstring

Negocios en esta etapa

pipelineIdstring

Negocios en este pipeline (si no se manda stageId)

orphanboolean

Negocios sin pipeline. Cualquier valor no vacío (incluso false) cuenta como verdadero · nullable

agentIdstring

Agente responsable

contactIdstring

Contacto del negocio

tagIdstring

Con esta etiqueta

valueMinnumber

Valor mínimo · ≥ 0 · nullable

valueMaxnumber

Valor máximo · ≥ 0 · nullable

expectedCloseAfterstring

Cierre esperado desde esta fecha (ISO 8601)

expectedCloseBeforestring

Cierre esperado hasta esta fecha (ISO 8601)

Respostas

200Página de negocios

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

{ "data": [ { "id": "clx1deal001", "code": "N-0031", "title": "Venta Apto Chapinero - María González", "value": "350000000.00", "currency": "COP", "probability": 40, "status": "OPEN", "closedAt": "2026-10-30T18:00:00.000Z", "expectedCloseDate": "2026-11-30T00:00:00.000Z", "lostReason": "Compró con otra inmobiliaria", "lostReasonCategory": "COMPETENCIA", "intent": "PURCHASE", "budgetMin": "300000000.00", "budgetMax": "400000000.00", "preferredZones": [ "Chapinero" ], "propertyTypes": [ "APARTMENT" ], "leadSource": "REFERRAL", "notes": "Pre-aprobada para crédito hipotecario.", "agentId": "clx1usr001", "contactId": "clx1con001", "createdAt": "2026-09-01T08:00:00.000Z", "updatedAt": "2026-09-25T16:45:00.000Z", "contact": { "id": "clx1con001", "firstName": "María", "lastName": "González", "phone": "+573001234567", "email": "[email protected]", "source": "WHATSAPP", "score": 75, "budget": "350000000.00" }, "agent": { "id": "clx1usr001", "firstName": "Carlos", "lastName": "Rodríguez" }, …