Skip to main content
The Prophia REST API is a JSON API over your portfolio data — the same accounts, properties, buildings, leases, documents, and tags you see in the app.

Base URL

Every resource is scoped to an account:

Your first call

1

Get an API key

See Authentication for key types and how to obtain one. If you plan to write as well as read, write access is a separate entitlement.
2

Find your account

The response lists the accounts your key can access — grab the id.
3

List your properties

Every endpoint page in this reference has a Try it playground — paste your key into the auth field and call the live API from your browser.

Learn the concepts

The endpoint pages document each operation; these pages explain the ideas that span them. Data concepts — what the objects mean

Data model

How accounts, properties, buildings, spaces, leases, documents, and tags relate — with the diagram.

Leases

Status fields, lease type, subleases, and the spaces a lease occupies.

Documents

Upload, the documentStatus lifecycle, categories, and change detection.

Tags

Extracted lease terms — how they’re structured, plus a reference to every term Prophia captures.

Spaces and encumbrances

Building spaces, applicable spaces, and which spaces are burdened by options.

Understanding onboarding

Why a building’s data is incomplete until Prophia finishes curating it — and how to tell.
API mechanics — how requests behave

Includes

Embed related resources in one request — and the rules that make it predictable.

Pagination, sorting, and filtering

The list envelope, paging rules, and per-resource sort and filter fields.

Errors and permissions

Status codes, the capabilities model, and why 404 sometimes means 403.

Errors

Requests fail with conventional status codes — 400 for malformed requests, 401 for key problems, 403/404 for permission and visibility issues. See Errors and permissions for the full semantics, including why a 404 can mean “no access”.