What is the URBLD API?
The URBLD API is a REST/OAuth 2.0 interface that exposes the full service-business lifecycle — leads, customers, scheduling, estimates, contracts, jobs, invoicing, payments, follow-ups, communications, and the Jarvis AI manager — as governed capabilities. Both human developers and autonomous AI agents can consume it. Full OpenAPI 3.1 spec at /openapi.json.
The URBLD Developer Portal is the front door for anyone — human or AI — building on top of URBLD's business operating system. Every capability you see inside the product is exposed here as a governed, tenant-scoped API.
Getting Started
Ship your first request against the URBLD API in five minutes.
Authentication
OAuth 2.0 authorization_code and client_credentials flows with 17 scopes.
API Reference
Full endpoint catalog rendered from the live OpenAPI 3.1 spec.
Webhooks
Subscribe to lead, job, invoice, and communication events with signed payloads.
Code Examples
Working requests in curl, TypeScript, and Python for every core capability.
AI Agents
How autonomous agents discover and consume URBLD capabilities.
Business OS API
The full lead-to-payment lifecycle as a single governed API surface.
CRM API
Leads, customers, deduplication, and lifecycle continuity.
Workflow API
Scheduling, jobs, follow-ups, and automation triggers.
Discovery documents
URBLD publishes every discovery document a modern AI agent expects to find:
/openapi.json— full OpenAPI 3.1 specification/.well-known/ai-capabilities.json— machine-readable capability manifest/agent.json— AI agent integration profile/llms.txt— LLM crawler guide/sitemap.xml— full public sitemap
Principles
- Tenant-scoped by default. Every token, request, and response is bound to a single organization. There is no global read path.
- Sacred ID continuity. A lead becomes a customer becomes a job under one immutable
lifecycle_number. IDs never break as records evolve. - Auditable mutations. Every destructive write is recorded to a tamper-resistant audit log with the resolved actor identity.
- Agent-first. Every capability documented for humans is also documented in a machine-readable form an autonomous agent can consume without a browser.
Frequently Asked Questions
Straight answers about how URBLD runs the business end-to-end.