API Reference

37 endpoints across 6 pillars. All routes require Bearer auth unless marked public.

Base URLhttps://digital-grid-production-cb20.up.railway.app/api/v1

AuthenticationPass your API key as Authorization: Bearer <key> or X-API-Key: <key>

GET/buildingsList buildings with optional filters

GET/buildings/:idGet building by ID with enrichment data

GET/buildings/:id/floorsList floors and spaces for a building

POST/buildingsCreate a new building record

GET/spacesList occupiable spaces across portfolio

GET/energy/metersList utility meters for a building

GET/leasesList leases with filters and field selection

GET/leases/:idFull lease record including clauses and dates

POST/leasesCreate a new lease record

PATCH/leases/:idUpdate lease fields

GET/financial/dashboardPortfolio-level financial KPIs

GET/invoicesInvoice and payment records

GET/service-requestsList service requests with status filters

POST/service-requestsCreate a new service request

GET/bookingsResource booking records

POST/bookingsCreate a resource booking

GET/visitorsVisitor records and check-in history

GET/work-ordersMaintenance work orders

GET/tenantsList tenant companies for the portfolio

GET/tenants/:idTenant detail with contacts and leases

GET/contactsContact records across all companies

GET/organizationsUniversal organization registry

GET/eventsBuilding events list

POST/eventsCreate a building event

GET/notificationsNotification records and templates

POST/notifications/sendSend a push or email notification

GET/metrics/tenant-healthTenant health scores (Enterprise only)

GET/metrics/building-healthBuilding health index

GET/market/benchmarksRent and occupancy benchmarks (Ent.)

GET/healthService health check (no auth)public

GET/auth/api-keysList API keys for authenticated user

POST/auth/api-keysCreate a new API key

DELETE/auth/api-keys/:idRevoke an API key

GET/webhooksList registered webhook endpoints

POST/webhooksRegister a new webhook

GET/developer/sdksList available SDKs (public)public

GET/developer/sandboxSandbox environment info (public)public