API Reference

Build with the same APIs that power the AirBills platform — REST, signed webhooks, OAuth.

api.airbills.co/v1OpenAPI 3.1TLS 1.3

Platform Capabilities

OAuth 2.0 + API Keys

OAuth for user-grant flows, scoped API keys for server-to-server.

Signed Webhooks

HMAC-signed events for bills, payments, residents, and disputes.

Full Sandbox

Dedicated test env with seeded data and webhook signing keys.

Official SDKs

TypeScript, Python, Ruby — generated from our OpenAPI spec.

TLS 1.3 + Encryption

All endpoints HTTPS, mutual TLS available on Enterprise.

Rate Limits + SLA

10,000 req/min on Pro, 99.95% uptime SLA.

Quickstart

// List bills for a property
const res = await fetch(
  'https://api.airbills.co/v1/properties/prop_abc/bills',
  { headers: { Authorization: 'Bearer ' + API_KEY } }
);
const { data } = await res.json();
console.log(data);

Endpoints

GET
/v1/properties

List properties in your portfolio.

POST
/v1/properties

Create a property.

GET
/v1/properties/{id}/bills

List bills for a property.

POST
/v1/bills

Submit a bill for AI capture.

GET
/v1/residents

List residents across properties.

POST
/v1/payments

Initiate a payment.

POST
/v1/webhooks

Register a webhook endpoint.

GET
/v1/reports/portfolio

Get live portfolio metrics.

Building Something With AirBills?

Talk to our developer relations team and get sandbox access.

Talk to DevRel