Skip to main content

Developer API

Read your organisation's data from your own systems and receive events as they happen. Keys and webhook endpoints are created by an organisation admin under Settings, API and webhooks. The read API and webhooks are included from the Professional plan; a write API follows on the Enterprise plan.

Authentication

Send the key as a bearer token. A key reads one organisation only; it is shown once at creation and stored hashed.

curl https://cuvanti.com/api/v1/properties \
  -H "Authorization: Bearer cuv_live_..."

Responses, pagination and limits

  • Every list returns { data: [...], next_cursor }. Pass cursor=<next_cursor> for the next page; limit is 50 by default and 200 at most.
  • Dates are ISO 8601 in UTC; money is a number in the organisation's currency; identifiers are Cuvanti ids.
  • 600 requests per minute per key. Over the limit the API answers 429 with a Retry-After header.
  • Errors are { error: { code, message } } with 401 (key), 403 (plan or suspended), 429 (rate) or 400 (bad filter).

Endpoints (GET)

PathReturnsFilters
/api/v1/meThe organisation the key belongs to and the rate limit.
/api/v1/propertiesProperties with address and type.updated_since
/api/v1/unitsUnits with bedrooms, floor area and asking rent.property_id, available
/api/v1/leasesLeases with term, rent per period, frequency and status.status, property_id, unit_id, tenant_id, updated_since
/api/v1/tenantsPeople holding a tenant membership.
/api/v1/chargesEvery rent and other charge with status, tax and late fee.lease_id, status, due_from, due_to, updated_since
/api/v1/paymentsCharges that have been paid, with the paid date and method.lease_id, paid_from, paid_to
/api/v1/ledgerPosted journal entries with their lines and account codes.from, to
/api/v1/enquiriesListing enquiries with channel, status and contact details.status, since

Write API (Enterprise)

On the Enterprise plan a key created with read and write scope may also create records. Send JSON; every POST may carry an Idempotency-Key header (up to 200 characters), and a repeat with the same key returns the first response with an Idempotent-Replayed header instead of creating twice. Validation errors answer 400 with the field path; a lease that overlaps an active lease answers 409; a cadence or charge above a state's rent-in-advance cap answers 422.

MethodPathDoesFields
POST/api/v1/propertiesCreates a property and its units.name, type, category?, address, address_line2?, city, state, postcode, country?, total_units?, year_built?, description?
PATCH/api/v1/properties/{id}Updates the fields given.name, type, category, address, address_line2, city, state, postcode, country, year_built, description, is_active
POST/api/v1/unitsAdds a unit to a property.property_id, name, type?, bedrooms?, bathrooms?, floor_area_sqft?, rent_amount?, is_available?
POST/api/v1/tenantsInvites a tenant; they receive Cuvanti's invitation e-mail.email, first_name, last_name, phone?
POST/api/v1/leasesCreates an active lease with the lease form's checks (overlap, rent-in-advance cap); emits lease.created.unit_id, tenant_id, start_date, end_date or periodic, rent_per_period, payment_frequency?, deposit?, auto_renew?, terms?
POST/api/v1/chargesRaises a rent charge on a lease (rent-in-advance cap applies).lease_id, due_date, amount, notes?
curl -X POST https://cuvanti.com/api/v1/leases \
  -H "Authorization: Bearer cuv_live_..." \
  -H "Idempotency-Key: lease-2026-10-22-unit-7" \
  -H "Content-Type: application/json" \
  -d '{ "unit_id": "...", "tenant_id": "...", "start_date": "2026-11-01", "end_date": "2027-10-31",
        "rent_per_period": 650, "payment_frequency": "WEEKLY", "deposit": 2600 }'

Webhooks

Register an HTTPS endpoint and choose events. Cuvanti POSTs a JSON body and retries a failed delivery up to six times with increasing delays. Reply with any 2xx status within ten seconds.

  • payment.paid: A rent charge was paid online or recorded as paid by staff.
  • lease.created: A lease was created.
  • ticket.created: A maintenance ticket was opened.
  • enquiry.received: A new listing enquiry arrived (web, e-mail, SMS, WhatsApp or WeChat).
  • invoice.submitted: A vendor submitted an invoice to the organisation.
  • invoice.paid: A vendor invoice was paid through Cuvanti.
  • property.created: A property was created (including through the API).
  • ping: A test event sent from Settings, API and webhooks.
POST https://example.com/cuvanti-webhook
X-Cuvanti-Event: payment.paid
X-Cuvanti-Delivery: <delivery id>
X-Cuvanti-Timestamp: 1760000000
X-Cuvanti-Signature: v1=<hex HMAC-SHA256>

{ "id": "<delivery id>", "event": "payment.paid", "created_at": "2026-10-22T20:00:00.000Z",
  "data": { "charge_id": "...", "lease_id": "...", "amount": 650, "currency": "AUD", "paid_at": "..." } }

Verify the signature with the endpoint's secret: HMAC-SHA256 over `${timestamp}.${rawBody}`, compared in constant time, and reject timestamps older than five minutes.

import crypto from "node:crypto";

export function verify(secret, headers, rawBody) {
  const ts = headers["x-cuvanti-timestamp"];
  const expected = "v1=" + crypto.createHmac("sha256", secret).update(ts + "." + rawBody).digest("hex");
  const given = headers["x-cuvanti-signature"];
  const fresh = Math.abs(Date.now() / 1000 - Number(ts)) < 300;
  return fresh && expected.length === given.length && crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(given));
}

AI assistants (MCP)

An AI assistant that speaks the Model Context Protocol (MCP) can read the same data with the same key: properties, units, leases, tenants, charges, payments, ledger and enquiries, plus an arrears summary. The server is read-only, stateless, answers each request in full (no event stream) and shares the key's rate limit. Nothing an assistant does here changes your records.

claude mcp add --transport http cuvanti https://cuvanti.com/api/mcp \
  --header "Authorization: Bearer cuv_live_..."
{
  "mcpServers": {
    "cuvanti": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://cuvanti.com/api/mcp",
               "--header", "Authorization: Bearer cuv_live_..."]
    }
  }
}

Assistants that take a remote MCP server with a bearer header (Claude Code, Cursor, Visual Studio Code, and desktop assistants through the mcp-remote bridge above) connect directly. Sign-in through OAuth, for assistants that require it instead of a key, is a later release.

ToolReturns
get_organizationThe organisation this key belongs to: name, country, currency, locale, type and plan, plus the key's name and the rate limit. Call this first to learn the currency and country.
list_propertiesProperties with address and type. Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
get_propertyOne property by id, with its address and type.
list_unitsUnits with bedrooms, floor area, asking rent and availability. Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
list_leasesLeases (tenancies) with term, rent per period, payment frequency, deposit and status (DRAFT, ACTIVE, EXPIRED, TERMINATED). Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
list_tenantsPeople holding a tenant membership in the organisation: name, e-mail, phone and membership status.
list_chargesEvery rent and other charge with due date, amount, total due, late fee, tax, status (PENDING, PROCESSING, PAID, OVERDUE, FAILED, REFUNDED, CANCELLED) and paid date. Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
list_paymentsCharges that have been paid, with the paid date and method. Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
list_ledger_entriesPosted journal entries with their lines, account codes and names. Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
list_enquiriesListing enquiries (leads) with channel, status (NEW, REPLIED, VIEWING_BOOKED, APPLIED, CLOSED), contact details and last message times.
arrears_summaryWho is behind on rent: unpaid charges (PENDING or OVERDUE) that fell due on or before a date, grouped by lease with the count, the outstanding total and the oldest due date, largest first. Follow up with list_leases and list_tenants for names. Money is a number in the organisation's currency; dates are ISO 8601 in UTC; identifiers are Cuvanti ids.
curl https://cuvanti.com/api/mcp \
  -H "Authorization: Bearer cuv_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "jsonrpc": "2.0", "id": 1, "method": "tools/call",
        "params": { "name": "arrears_summary", "arguments": {} } }'

What the assistant reads goes to the assistant you connect, under that provider's terms; connecting one is your choice and your agreement with that provider, and Cuvanti sends nothing to it on its own.

Accounting exports

Beside the API, the ledger exports to Xero and QuickBooks by connection, to DATEV for Germany and to MYOB Business (general-journal import file) for Australia and New Zealand, under Accounting.

Questions, or a field you need that is not here: hello@cuvanti.com · Integrations · Trust