How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PEXA Project API

The Project API from PEXA — 4 operation(s) for project.

PEXA Project API is one of 18 APIs that PEXA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, authentication docs, and API documentation.

This API exposes 4 operations across 4 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version v4.

Requests are made against a single base URL, {{ service.url }}.

4 operations 4 paths 22 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v4
Base URL
https://api.pexa.com.au
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

PEXA Project API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode and clientCredentials flows, exposing 3 scopes.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Project 4
POST
/v4/projects
Create Project
createProject 1 param body → 201400401403500
PUT
/v4/projects/{projectId}
Update Project
updateProject 2 params body → 200400401403500
GET
/v4/projects/{projectId}/statuses
Fetch the status details for a project Scopes: au:projects:status:read
statuses 2 params → 200400401403500
GET
/v4/projects/{projectId}/workspaces
Fetch the list of workspaces of a project Scopes: au:projects:workspaces:read
workspaces 2 params → 200400401403500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Project (20 properties), ProjectsWorkspace (11 properties), SupplierDetails (9 properties), ProjectStatus (8 properties). Each schema is shown below with its type and property counts.

NswPropertyDetails
object
Property details for the NSW jurisdiction
2 properties
GstWithholdingStatus
string
The status of GST withholding. Can be one of the following: MATCHING - Form one lodged via PEXA and GST line item created MANUAL - Form one not lodged via PEXA…
MotParticipants
object
Details on incoming mortgagees
4 properties 3 required
VicPropertyDetails
object
Property details for the VIC jurisdiction
7 properties 1 required
Project
object
Object with all required details for a Project
20 properties 9 required
ProjectStatus
object
Status details of a project
8 properties
CurrentLandUse
string
Current land use
SmokeAlarm
object
Smoke alarm are the devices that are able to detect smoke in the event of a fire and sound an alarm to alert people to the potential danger. In QLD, it's a leg…
2 properties
Error
object
Error related to the API
3 properties
ParticipantSettlementDateStatus
string
The status of settlement date acceptance by a participant. Can be one of the following: ACCEPTED - Accepted PENDING - Awaiting Response
SettlementDateStatus
string
The overall status of settlement date acceptance. Can be one of the following: ACCEPTED - All Accepted PARTIALLYACCEPTED - Pending others PENDING - Pending NOA…
SafetySwitch
object
A safety switch is a device that quickly switches off the electric supply if an electric fault is detected, to minimise the risk of electricity -related fires,…
2 properties
WorkspaceCountsByStatuses
object
Counts for various properties of workspaces under the project
6 properties
Errors
object
List of errors related to the API
1 property
PrimaryConstructionType
string
Material used to construct the property. Example - Timber, Brick etc
QldPropertyDetails
object
Property details for the QLD jurisdiction
4 properties
ProjectsWorkspace
object
Details of a workspace
11 properties
SettlementDateAcceptanceStatus
object
Counts for settlement date acceptance
2 properties
SupplierDetails
object
Details for the supplier
9 properties 8 required
InvitationAcceptanceStatus
object
Counts of the various statuses for an invitation
4 properties
Jurisdiction
string
Jurisdiction
PrimaryLandUse
string
For which purpose the land will be used for. Example - dwelling, carpark, flat multi-storey etc

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pexa-project-api-openapi.yml Raw ↑

Other APIs PEXA publishes across the network.

PEXA Exchange API
PEXA Billing API
PEXA Conversation API
PEXA Document API
PEXA Health Check API
PEXA Invitation API
PEXA Landtitle API
PEXA Notification API
PEXA Notification Service [$] API
PEXA Notification Registration API
PEXA Settlement API
PEXA Standalone Discharge Experience API
Where this information came from

This is an independent, third-party profile of PEXA Project API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.