developers · agents · integrations
The BaseOS REST API, its OpenAPI 3.0 specification, signed outbound webhooks, and the BaseOS MCP endpoint — with the jobs each one is the right tool for.
when to use it
Each job below names the endpoints that do it. If your job is not on this list, the API reference is the place to check before assuming it is missing.
Push a lead, contact, account, or opportunity into a pipeline a human sales team already works in — including the next action and its due date.
Answer questions about projects, their tasks and their delivery dates without scraping a UI.
File a ticket into the right department, add a reply, and move it along the NEW → OPEN → RESOLVED state machine.
Build a quote from catalog items, then read the financial accounts and double-entry transactions it turns into.
Read the cross-module activity timeline instead of stitching one together from each resource's list endpoint.
Subscribe to outbound webhooks instead of polling. Every delivery is a JSON POST signed with HMAC-SHA256 using the endpoint's secret.
Speak Model Context Protocol against a single tenant, with the same module gating a human member has. Needs an API key carrying the `mcp:use` scope — no existing key inherits it.
when not to
first call
GET /api/v1/clients?page=1&limit=25 HTTP/1.1 Host: baseos.dev Authorization: Bearer <api_key> Accept: application/json
401 means the key is wrong. 403 means the key is right and the organization has not activated the module that owns the resource.
every resource, at a stable url
Interactive Swagger UI for every REST endpoint, with request and response schemas and a try-it console.
/docs/api
The machine-readable contract the reference is generated from. Import it into Postman, Insomnia, or an SDK generator.
/api/docs/swagger.json
Every endpoint, webhook event, and authentication rule as one markdown file, written to be read in a single request.
/llms.txt
Model Context Protocol endpoint. Point an MCP-capable agent at it with an API key to read and write BaseOS records as tools.
/api/v1/mcp · sign in required
Where an organization admin mints and revokes the bearer tokens every /api/v1 request needs. Requires a signed-in admin.
/home/settings/api-keys · sign in required
Register outbound webhook URLs, read the signing secret, and send a signed test delivery. Requires a signed-in admin.
/home/settings/webhooks · sign in required
The OpenAPI file is public and needs no account. Keys are minted by an organization admin, and creating an organization is free.
A beta fundadora está abertaA beta fundadora está aberta — entre cedo e ajude a moldar o BaseOS
Começar