Interactive demo · fictional business data

API Documentation

Complete endpoint reference for the Built Correct platform.

Leads

/api/leads

GET/api/leadsList all leads with filteringAuth
POST/api/leadsCreate a new leadAuth
GET/api/leads/:idGet lead detailsAuth
PATCH/api/leads/:idUpdate leadAuth
DELETE/api/leads/:idSoft-delete leadAuth
POST/api/leads/:id/convertConvert lead to customerAuth
PATCH/api/leads/:id/stageUpdate lead stageAuth

Customers

/api/customers

GET/api/customersList all customersAuth
POST/api/customersCreate customerAuth
GET/api/customers/:idGet customer detailsAuth
PATCH/api/customers/:idUpdate customerAuth
DELETE/api/customers/:idSoft-delete customerAuth

Estimates

/api/estimates

GET/api/estimatesList estimatesAuth
POST/api/estimatesCreate estimateAuth
GET/api/estimates/:idGet estimate detailsAuth
PATCH/api/estimates/:idUpdate estimateAuth
POST/api/estimates/:id/duplicateDuplicate estimateAuth
POST/api/estimates/:id/sendSend estimate to customerAuth
PATCH/api/estimates/:id/stageUpdate estimate stageAuth

Work Orders

/api/work-orders

GET/api/work-ordersList work ordersAuth
POST/api/work-ordersCreate work orderAuth
GET/api/work-orders/:idGet work order detailsAuth
PATCH/api/work-orders/:idUpdate work orderAuth
PATCH/api/work-orders/:id/statusUpdate work order statusAuth
POST/api/work-orders/:id/assignAssign installerAuth

Purchase Orders

/api/purchase-orders

GET/api/purchase-ordersList purchase ordersAuth
POST/api/purchase-ordersCreate purchase orderAuth
GET/api/purchase-orders/:idGet PO detailsAuth
PATCH/api/purchase-orders/:idUpdate POAuth
POST/api/purchase-orders/:id/receiveReceive PO itemsAuth
GET/api/purchase-orders/:id/price-flagsGet price discrepancy flagsAuth
POST/api/purchase-orders/:id/price-flags/:itemId/resolveResolve price flagAuth

Invoices

/api/invoices

GET/api/invoicesList invoicesAuth
POST/api/invoicesCreate invoiceAuth
GET/api/invoices/:idGet invoice detailsAuth
PATCH/api/invoices/:idUpdate invoiceAuth
POST/api/invoices/:id/sendSend invoice to customerAuth
POST/api/invoices/:id/voidVoid invoiceAuth

Payments

/api/invoice-payments

GET/api/invoice-paymentsList paymentsAuth
POST/api/invoice-paymentsRecord paymentAuth
GET/api/invoice-payments/:idGet payment detailsAuth
DELETE/api/invoice-payments/:idVoid paymentAuth

Change Orders

/api/change-orders

GET/api/change-ordersList change ordersAuth
POST/api/change-ordersCreate change orderAuth
GET/api/change-orders/:idGet change order detailsAuth
PATCH/api/change-orders/:idUpdate change orderAuth
POST/api/change-orders/:id/approveApprove change orderAuth
POST/api/change-orders/:id/sync-qbSync supplemental invoice to QuickBooksAuth

Inventory

/api/inventory

GET/api/inventoryList inventory itemsAuth
POST/api/inventoryCreate inventory itemAuth
PATCH/api/inventory/:idUpdate inventoryAuth
POST/api/inventory/adjustAdjust inventory quantityAuth
GET/api/inventory/alertsGet inventory alertsAuth

Commissions

/api/commissions

GET/api/commissionsList commission recordsAuth
POST/api/commissions/calculateCalculate commissions for periodAuth
POST/api/commissions/:id/approveApprove commission payoutAuth
GET/api/commissions/summaryCommission summary by repAuth

Users

/api/users

GET/api/usersList all usersAuth
POST/api/users/createCreate user with passwordAuth
POST/api/users/inviteInvite user via emailAuth
GET/api/users/:idGet user detailsAuth
PATCH/api/users/:idUpdate userAuth
DELETE/api/users/:idSoft-delete userAuth
POST/api/users/:id/deactivateDeactivate userAuth
POST/api/users/:id/reactivateReactivate userAuth
POST/api/users/:id/reset-passwordAdmin password resetAuth
PATCH/api/users/:id/roleUpdate user roleAuth
POST/api/users/:id/unlockUnlock locked accountAuth
POST/api/users/:id/toggle-2faToggle 2FAAuth

Admin

/api/admin

GET/api/admin/rolesList all rolesAuth
GET/api/admin/roles/:idGet role with permissionsAuth
POST/api/admin/rolesCreate custom roleAuth
PATCH/api/admin/roles/:idUpdate roleAuth
PUT/api/admin/roles/:id/permissionsSet role permissionsAuth
GET/api/admin/audit-logQuery audit logAuth
GET/api/admin/page-access-matrixGet page access matrixAuth
PUT/api/admin/page-access-matrixToggle page accessAuth

Settings

/api/settings

GET/api/settingsGet all settingsAuth
PATCH/api/settingsUpdate settingsAuth
GET/api/settings/state-tax/:stateCodeGet state tax referenceAuth

Integrations

/api/integrations

GET/api/integrationsIntegration dashboard (stats, events, config)Auth
GET/api/integrations/configGet Flooring Studio integration configAuth
PATCH/api/integrations/configUpdate Flooring Studio configAuth
GET/api/integrations/eventsList integration eventsAuth
POST/api/integrations/retry/:eventIdRetry failed eventAuth
POST/api/integrations/retry-allRetry all failed eventsAuth
POST/api/integrations/webhook/dotnetReceive Flooring Studio webhookPublic

QuickBooks

/api/qb

POST/api/qb/connectStart OAuth flowAuth
GET/api/qb/callbackOAuth callbackAuth
POST/api/qb/disconnectDisconnect QBAuth
GET/api/qb/statusConnection & sync statusAuth
POST/api/qb/sync/full-reconciliationFull bidirectional syncAuth
POST/api/qb/sync/allSync all pending recordsAuth
POST/api/qb/sync/customer/:idSync single customerAuth
POST/api/qb/sync/invoice/:idSync single invoiceAuth
POST/api/qb/sync/payment/:idSync single paymentAuth
GET/api/qb/conflictsList sync conflictsAuth
PATCH/api/qb/conflicts/:idResolve conflictAuth
GET/api/qb/logsSync event logAuth
GET/api/qb/tax-code-mappingTax code mappingsAuth
PATCH/api/qb/tax-code-mappingSave tax code mappingsAuth
GET/api/qb/account-mappingAccount mappingsAuth
PATCH/api/qb/account-mappingSave account mappingsAuth

Webhooks

/api/webhooks

GET/api/webhooksList webhook configsAuth
POST/api/webhooksCreate webhookAuth
PATCH/api/webhooks/:idUpdate webhookAuth
DELETE/api/webhooks/:idDelete webhookAuth
GET/api/webhooks/:id/deliveriesDelivery logAuth
POST/api/webhooks/:id/testSend test payloadAuth