API

Developers

Build on the PropertyOS API — read your properties and tenancies from your own tools and integrations.

View API reference Download TypeScript SDK

1. Generate a key

Create an API key from Settings → Organisation → API keys.

2. Call the API

Send it as an X-Api-Key header on any public API request.

3. Read the reference

Browse the full endpoint reference and try requests right from the docs.

Quickstart

curl https://propertyos-api-test.oleksii-veselovskyi.com/api/v1/public-api/v1/properties \
  -H "X-Api-Key: YOUR_API_KEY"

Public API requests are limited to 60 per minute per key.

Generated TypeScript SDK

A typed TypeScript client for the public API — request/response types plus a thin fetch wrapper, no dependencies. Not published to npm; download and copy into your project.

Download TypeScript SDK

Ready to get organised?

Start managing your properties in minutes. No credit card required.

Get started View API reference