Skip to content
tlyfePro Partner API

Introduction

The Partner API lets an Enterprise Partner call tlyfePro services directly from their own systems, using an API key. Everything you reach through the API is bounded to your own company’s data — a key can never see another partner’s or OpenBrix’s records.

What you can call

Section titled “What you can call”

The API exposes four services. Which ones your key can use is governed by your key’s scopes and your brand’s entitlements (see Scopes & entitlements):

Progression

Tenancy progression flows (OpenFlow) — create and drive a flow, references, documents, offers, deposits, move-in. Scope: progression.

Rent Ready

Pre-qualification / rent-ready checks for applicants. Scope: rent_ready.

Maintenance

Maintenance issues raised against a tenancy. Scope: maintenance.

Portal

Property portal — leads and listings for your branch. Scope: portal.

How access works

Section titled “How access works”

Every partner request passes two independent gates, and both must allow it:

  1. Your key is verified

    The key resolves to your brand. Revoked, expired or malformed keys are rejected with 401. See Authentication.

  2. Scope check

    The endpoint’s service must be in your key’s scopes, or you get 403.

  3. Entitlement check

    Your brand must be entitled to that service, or you get 403 — even if the scope would have allowed it.

Because the key resolves to your own company server-side, standard per-agent scoping then applies: list endpoints return only your data, and record endpoints reject ids that aren’t yours. This is data isolation — it is enforced at the query layer, not by obscurity.

Base URL

Section titled “Base URL”
https://wl.api.cluster.openbrix.co.uk

Ready to make your first call?

QuickstartMake your first authenticated Partner API call.