Developers · product API · OpenAPI 3.1

Same permissions. Same holds. No /serve.

Everything in the interface is available over the API except serving and signing a notice. The OpenAPI document is public, keys come from your own account — no partner programme, no sales call — and every operation an assistant may use is also an MCP tool for Claude, ChatGPT and other assistants.

Not available over the API. There is no POST /serve. Generate, preview and sign a prescribed form over the API. Recording service is POST /api/v1/issued-documents/{id}/record_service — a human confirmation that a notice was served, not a machine that serves it.

What this platform is

  • Let Claude or ChatGPT work in your account, alongside your email and accounts
  • Push tenancies from the CRM you already run
  • Pull the rent range into a pricing tool
  • Add comparable lettings to a rent review from your own records
  • Put tribunal referral deadlines into your case management
  • Show landlords the activity feed in your own portal
  • Feed the rent roll into finance
  • Pull service records into case management
  • Build an integration for other agencies

Limits and money

Amounts are integer pence. List routes paginate with page and per_page. Partner rate limits are confirmed when you receive a key.

Envelope is { data, meta? } on success and { error: { code, message, details } } on failure.

Docs

API keys

Issue, name, rotate and revoke keys in the product. A key acts as the paying account and is shown once.

Docs

Authentication

Authenticate to the Abide.Rent API with a session JWT or a hashed API key. Context headers choose which workspace you see.

Docs

Errors and status codes

Every error has the same shape and a stable code. Branch on the code, not on the message.

Docs

Getting started

Get started with the Abide.Rent API: the signed-in product and the API are the same /api/v1 surface, with the same permissions.

Docs

Lists, pages and filters

List endpoints page with page and per_page, and accept search and simple filters.

Docs

Money, dates and ids

Integer pence, UK dates as YYYY-MM-DD, UTC timestamps and numeric ids. The rules every field follows.

Docs

Notices and service: what the API will and won’t do

The API generates and records notices. It never serves one. Here is exactly where the line is.

Docs

Rate limits

300 requests a minute per person or API key, with tighter limits on sign-in and one-time codes.

Docs

Walkthrough: from a new property to a rent review

Create a property with its tenancy, price a rent increase, get the landlord’s approval and generate Form 4A — every call, in order.

Docs

Workspaces and context headers

One person can be an agent, a landlord and a tenant. Every API call names which workspace it acts in, with two headers.

Language models

MCP and AI

Connect Claude, ChatGPT or Cursor to one account. Every API operation an assistant may use is a tool; read only or read and make changes. Serving or signing a notice, payments and access changes are never tools.

Contract

OpenAPI 3.1

Download the spec Scalar renders. There is no /serve route.

CRM connectors and outbound webhooks are planned and are not live yet. Import a CSV or use the API until they are. Serving a notice is never available over the API. The API and MCP are on Portfolio and the free trial; Solo, the free plan, has no API access. AI assistants connect to the MCP server by signing in as a person, not with an API key.