Skip to content
Vespy API

Vespy API

One REST API for the whole portfolio — properties and leases, rent and trust accounting, maintenance, and the integrations that tie them together.
QuickstartBrowse the API reference

Start here

Quickstart gets you an access token and a first authenticated request. Authentication covers token lifetimes and refresh.

Every endpoint

The API reference is generated from the OpenAPI contract that ships with the server, so it never drifts from what the API actually does.

Workflows

The guides walk through multi-step flows — leasing, rent and payments, trust accounting, maintenance, and migration.

Try it live

The playground runs requests against the spec in your browser.

Conventions

Section titled “Conventions”
  • Base URL — https://api.getvespy.com. Every path is prefixed with /api.
  • Authentication — Authorization: Bearer <access token> on every endpoint except the webhook receivers, which authenticate by provider signature.
  • Money — always integer cents in a *Cents field. There are no floating point amounts.
  • Dates — YYYY-MM-DD for calendar dates, RFC 3339 UTC timestamps for everything else.
  • Identifiers — UUIDs. Every resource is scoped to the organizationId on your token.

For agents and tools

Section titled “For agents and tools”

The spec and the prose are both machine-readable:

URL What it is
/llms.txt Start here — links everything below
/llms-api.txt Every endpoint in one file: method, path, auth, parameters, body, responses
/llms-full.txt The hand-written guides as one document
/openapi.json The public OpenAPI 3.0 document, with complete JSON Schemas
<any page>.md That page as raw markdown — e.g. /getting-started/authentication.md

Operation pages live at /api/operations/<operationId>/, and operationId is derived deterministically from the method and path — GET /api/work-orders/{id} becomes get-api-work-orders-by-id. Links into the reference keep working when routes are reordered or moved between modules.