← All docs

API access

Call the Property module directly from your own systems, using a key tied to your organisation.

Minting a key

Anyone with the "manage integrations" permission can create an API key for your organisation from the API keys endpoint under Organisations - give it a name so you know what it's for later, and optionally an expiry date. The full key is shown exactly once at creation time, so store it somewhere safe straight away.

Using it

Send the key as a bearer token on any Property module request - properties, applicants, viewings, valuations, brochures, and enquiries all accept it exactly the way they accept a normal logged-in session, including the same subscription and module checks.

  1. Authorization: Bearer <your-key>
  2. GET /api/v1/organisations/{organisation_id}/properties

Revoking access

Revoke a key at any time from the same place it was created - it stops working immediately, with no effect on anyone's logged-in session.