ByDomuDevelopers
Create key

Listar comisiones

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

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Comisiones de la organización con filtros por estado, agente, negocio y fecha de cierre (pageSize máximo 500).

Permission
commissions:read
Keys
Secret only (server-side)

Headers

X-API-Keystringrequired
Your secret key.

Query parameters

pageinteger
Página, desde 1 · default=1 · ≥ 1
pageSizeinteger
Comisiones por página (máximo 500) · default=20 · 1–500
cursorstring
Se valida pero no se aplica en esta operación
includeTotalboolean | string
Se valida pero no se aplica en esta operación
sortBystring
Campo de orden (por defecto closedAt) · default="createdAt"
sortOrderstring
Dirección del orden ascdesc · default="desc"
searchstring
Referencia, título o código del negocio, o código de su propiedad
statusstring
Estado de la comisión PENDIENTEFACTURADAPAGADA_PARCIALPAGADACANCELADA
agentIdstring
Agente del negocio
dateFromstring
Cerradas desde esta fecha (ISO 8601) · nullable
dateTostring
Cerradas hasta esta fecha (ISO 8601) · nullable
dealIdstring
Negocio

Responses

200Página de comisiones
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.
cURL
curl "https://api.bydomu.com/v1/commissions" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/commissions", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/commissions",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": [
    {
      "id": "clx1com001",
      "referenceNumber": "COM-2026-0015",
      "status": "PENDIENTE",
      "commissionType": "PERCENTAGE",
      "commissionBase": "PROPERTY_PRICE",
      "baseAmount": "350000000.00",
      "percentage": "3.00",
      "grossAmount": "10500000.00",
      "currency": "COP",
      "reteFuente": "1050000.00",
      "reteIca": "105000.00",
      "reteIva": "0.00",
      "netAmount": "9345000.00",
      "paidAmount": "0.00",
      "invoiceNumber": "FE-1042",
      "invoiceDate": "2026-09-28T00:00:00.000Z",
      "notes": "Pendiente la escritura",
      "closedAt": "2026-09-20T16:00:00.000Z",
      "dealId": "clx1deal001",
      "createdAt": "2026-09-20T16:00:00.000Z",
      "updatedAt": "2026-09-25T10:00:00.000Z",
      "deal": {
        "id": "clx1deal001",
        "code": "N-0031",
        "title": "Venta Apto Chapinero",
        "agent": {
          "id": "clx1usr001",
          "name": "Carlos Rodríguez"
        },
        "contact": {
          "id": "clx1con001",
          "firstName": "María",
          "lastName": "González"
        },
        "properties": [
          {
            "property": {
              "id": "clx1prop001",
              "title": "Apartamento en Chapinero con vista",
              "transactionType": "SALE"
            }
  …

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.