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 Workspaces API

The Workspaces API from PEXA — 6 operation(s) for workspaces.

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

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

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

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

9 operations 6 paths 30 schemas 2 DELETE5 POST2 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 Workspaces 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 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 9
POST
/v4/projects/{projectId}/workspaces
Create a new workspace for an existing Project Scopes: au:projects:workspaces:write
createWorkspace 2 params body → 201400
PUT
/v4/projects/{projectId}/workspaces/{pexaWorkspaceId}
Update a workspace
updateWorkspace 3 params body → 200401403404500
POST
/v4/projects/{projectId}/workspaces/{workspaceId}/financials
Create Financial Settlement Line Items
createFinancials 3 params body → 201401403404500
POST
/v4/projects/{projectId}/workspaces/{workspaceId}/parties
Add Parties
addParties 3 params body → 201401403404500
PUT
/v4/projects/{projectId}/workspaces/{workspaceId}/parties
Update Parties
updateParties 3 params body → 204401403404500
DELETE
/v4/projects/{projectId}/workspaces/{workspaceId}/parties
Delete Parties
deleteParties 3 params body → 204401403404500
POST
/v4/projects/{projectId}/workspaces/{workspaceId}/participants
Add Participants
addParticipants 3 params body → 201401403404500
DELETE
/v4/projects/{projectId}/workspaces/{workspaceId}/participants
Delete Participants
deleteParticipants 3 params body → 204401403404500
POST
/v4/projects/{projectId}/workspaces/{pexaWorkspaceId}/settlementDates
Propose Settlement Date
proposeSettlement 3 params body → 204401403404500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Schedule.LineItem (10 properties), UpdateParty (10 properties), Party (9 properties), Workspace (8 properties). Each schema is shown below with its type and property counts.

Schedule.LineItem
object
10 properties
UpdateParty
object
A party
10 properties 4 required
Schedule.LineItem.AccountDetails.Source
object
2 properties
UpdateWorkspaceResponse
object
Response to updating a workspace
3 properties
WarningResponseType
object
2 properties
PartyResponse
object
Response object for a party
4 properties
ProposeSettlementRequest
object
Request to propose settlement dates
2 properties
DeleteParty
object
Party to be deleted
1 property 1 required
Schedule.LineItem.AccountDetails.Destination.BPay
object
2 properties
UpdatePartiesRequest
object
Request to update parties on an existing workspace
1 property 1 required
Workspace
object
Object with all required details for a workspace
8 properties 2 required
QldWorkspaceDetails
object
Workspace details for the QLD jurisdiction
7 properties
IncomingProprietor
object
Details for an Incoming Proprietor
2 properties 2 required
SettlementUploadResponse
object
1 property
AddParticipantsResponse
object
Response when adding participants
2 properties
Error
object
Error related to the API
3 properties
Party
object
A party
9 properties 3 required
DeletePartiesRequest
object
Request to delete parties on an existing workspace
1 property 1 required
UpdateWorkspaceRequest
object
Request to update a workspace
2 properties
Schedule.LineItem.AccountDetails.Destination.Account
object
3 properties
SettlementUploadRequest
object
2 properties
DeleteParticipantsRequest
object
Request to delete participants
1 property
AddPartiesResponse
object
Response when adding parties
2 properties
Schedule
object
1 property
Errors
object
List of errors related to the API
1 property
AddParticipantsRequest
object
Request to add participants to an existing workspace
1 property
AddPartiesRequest
object
Request to add parties to an existing workspace
1 property
Schedule.LineItem.AccountDetails.Destination
object
4 properties
Schedule.LineItem.AccountDetails
object
2 properties
ResponseParticipant
object
Response object when adding a participant
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pexa-workspaces-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 Project API
PEXA Settlement API
Where this information came from

This is an independent, third-party profile of PEXA Workspaces 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.