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

The Invitation API from PEXA — 6 operation(s) for invitation.

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

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

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

Requests are made against a single base URL, https://localhost/.

6 operations 6 paths 24 schemas 2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.pexa.com.au
Resource Areas
1

Paths & Operations 6

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

Invitation 6
PUT
/v1/subscriber/invitation
Respond to invitation received
respondInvitationV1UsingPUT body → 200201401403404
GET
/v1/subscriber/invitations
Retrieves outstanding invitations
retrieveOutstandingInvitationsV1UsingGET 3 params → 200401403404
POST
/v1/workspace/invitation
Create Workspace Invitation
createInvitationUsingPOST body → 200201401403404
PUT
/v2/subscriber/invitation
Respond to invitation
respondInvitationV1UsingPUT body → 200201401403404
GET
/v2/subscriber/invitations
Retrieve outstanding invitations
retrieveOutstandingInvitationsV1UsingGET 3 params → 200401403404
POST
/v2/workspace/invitation
Create workspace Invitation
createInvitationUsingPOST body → 200201401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite_2 (14 properties), au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite (11 properties), au.net.pexa.api.schema._1.RespondInvitationRequest (9 properties), au.net.pexa.api.schema._1.RespondInvitationRequest_2 (9 properties). Each schema is shown below with its type and property counts.

au.net.pexa.api.schema._1.InvitationRetrievalResponse
object
2 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails
object
1 property
au.net.pexa.api.schema._1.RespondInvitationRequest
object
9 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite
object
11 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails.Party
object
2 properties
au.net.pexa.api.schema._1.ParticipantDetailsDetailType
object
1 property
au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest
object
7 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle
object
2 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails
object
1 property
au.net.pexa.api.schema._1.CreateWorkspaceInvitationResponse
object
1 property
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails.Caveat
object
Registered caveat dealing number
1 property
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails
object
Proprietor details of the associated land title. Only returned if workspace role of the invitee is Incoming Proprietor (IP) and Mortgagee On Title (MOT).
1 property
au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest_2
object
8 properties
au.net.pexa.api.schema._1.RespondInvitationRequest.ForwardedParticipantDetails
object
Participant details of the subscriber that is being forwarded the invitation. Mandatory if invitation response is 'Forward to another Subscriber' or 'Forward t…
2 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle_2
object
5 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails
object
Registered mortgages on the associated land title. Only returned if the workspace role of the invitee is Mortgagee On Title (MOT).
1 property
au.net.pexa.api.schema._1.RespondInvitationRequest_2
object
9 properties
au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails.Party
object
1 property
au.net.pexa.api.schema._1.ParticipantDetailsDetailType_2
object
1 property
au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails
object
1 property
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite_2
object
Invite id
14 properties
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails
object
Registered caveats on the associated land title. Only returned if the workspace role of the invitee is Caveator On Title (COT).
1 property
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails.Mortgage
object
Registered mortgage dealing number
1 property
au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails.Proprietor
object
Proprietor name
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pexa-invitation-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 Landtitle API
PEXA Notification API
PEXA Notification Service [$] API
PEXA Notification Registration API
PEXA Project API
PEXA Settlement API
PEXA Standalone Discharge Experience API
Where this information came from

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