Proplix Secure API Gateway · Version 1.0.0

Property, tenancy and compliance workspaces

Fetch linked properties, tenancies, compliance summaries, property requests, maintenance and authorised certificates.

18 code-backed guidesExact navigationInterlinked workflows

Guides in this workflow

Follow the guide that matches the exact action, filter, menu change or issue.

Open the Scroll workspace endpoint

Use /portal_api/scroll_workspace to fetch supported compliance-application workspaces.

Valid short-lived client session

Understand supported case workspaces

Full Compliance Applications, Licence Applications and One-Off Compliance model configurations are recognised.

Valid short-lived client session

Fetch property status

Use /portal_api/scroll_property_status for linked-property, tenancy and compliance information.

Valid short-lived client session

Read linked properties

The endpoint builds property rows from client/property links.

Valid short-lived client session

Read property summary

Receive safe property identity/address/status data.

Valid short-lived client session

Read client summary

Receive the authenticated client summary used by the portal.

Valid short-lived client session

Read landlord ownership context

Data remains tied to the authenticated client/property relationship.

Valid short-lived client session

Read tenant and tenancy context

Compatible tenancy/tenant tables are queried with ownership and approval rules.

Valid short-lived client session

Read compliance records

The gateway collects linked compliance records and decorates safe public labels/status.

Valid short-lived client session

Understand client-approved records

Only records passing client-approval/visibility conditions are exposed.

Valid short-lived client session

Read compliance summary

The response aggregates counts/status across linked properties.

Valid short-lived client session

Read property requests

Compatible property/client request records can be included.

Valid short-lived client session

Read maintenance requests

Compatible maintenance records can be included for linked properties.

Valid short-lived client session

Read property activity

The adapter collects safe activity rows from compatible sources.

Valid short-lived client session

Download a compliance certificate

Use /portal_api/scroll_property_certificate for an authorised record.

Valid short-lived client session

Understand certificate authorisation

The record must be visible to the client and linked to an owned property/tenancy context.

Valid short-lived client session

Understand certificate path protection

The gateway resolves a safe readable PDF path and rejects paths outside approved roots.

Valid short-lived client session

Resolve missing property data

Check property-client links, tenant matching, module schemas and client approval.

Valid short-lived client session