Skip to content

Corretores — Endpoints

Base URL: /api/brokers

Permissões: Admin (CRUD completo)


GET /api/brokers

Lista corretores da empresa com paginação.

Query params:

ParâmetroTipoDescrição
pageintegerPágina (padrão: 1)
pageSizeintegerItens por página (padrão: 20)
searchstringBusca por nome, e-mail, CRECI
statusstringFiltro: Active, Inactive

Resposta 200:

json
{
  "data": [
    {
      "id": "b1c2d3e4-...",
      "name": "Paulo Corretor",
      "creci": "CRECI-SP 12345",
      "email": "paulo@imob.com",
      "phone": "(11) 97777-0001",
      "status": "Active",
      "totalSales": 12,
      "totalLeases": 28,
      "conversionRate": 0.74,
      "createdAt": "2026-01-15T08:00:00Z"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 8,
  "totalPages": 1,
  "hasNext": false,
  "hasPrevious": false
}

GET /api/brokers/:id

Retorna detalhes completos de um corretor.

Resposta 200:

json
{
  "id": "b1c2d3e4-...",
  "name": "Paulo Corretor",
  "creci": "CRECI-SP 12345",
  "email": "paulo@imob.com",
  "phone": "(11) 97777-0001",
  "status": "Active",
  "totalSales": 12,
  "totalLeases": 28,
  "conversionRate": 0.74,
  "address": {
    "street": "Rua Corretor",
    "number": "99",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01001-000"
  },
  "notes": "Especialista em imóveis comerciais.",
  "createdAt": "2026-01-15T08:00:00Z",
  "updatedAt": "2026-05-10T10:00:00Z"
}

POST /api/brokers

Cadastra um novo corretor.

Body:

json
{
  "name": "Fernanda Vendas",
  "creci": "CRECI-SP 99999",
  "email": "fernanda@imob.com",
  "phone": "(11) 96666-0002",
  "status": "Active",
  "address": {
    "street": "Av. dos Corretores",
    "number": "200",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "04001-000"
  }
}
CampoTipoObrigatório
namestringSim
crecistringSim (único no sistema)
emailstringSim
statusstringSim

Resposta 201: Objeto do corretor criado.

Erros:

  • 409 — CRECI já cadastrado

PUT /api/brokers/:id

Atualiza dados do corretor.

Resposta 200: Objeto atualizado.


DELETE /api/brokers/:id

Remove o corretor (soft delete).

Permissões: Admin

Resposta 204: Sem conteúdo.

Erros:

  • 400 — Corretor possui contratos ou propostas ativas

Documentação do FastGivr SystemImob