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

VaultRE User API

Operations related to users

VaultRE User API is one of 50 APIs that VaultRE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, authentication docs, and code examples.

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

Requests are made against 3 base URLs: https://ap-southeast-2.api.vaultre.com.au/api/v1.1, https://ap-southeast-2.api.vaultre.com.au/api/v1.2, https://ap-southeast-2.api.vaultre.com.au/api/v1.3.

39 operations 31 paths 54 schemas 2 DELETE28 GET3 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://ap-southeast-2.api.vaultre.com.au/api/v1.3
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

VaultRE User API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Api-Key (Api-Key). An API key is passed in the header as Authorization (Bearer).

  • Bearer — Use format 'Bearer [token]'

Paths & Operations 39

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

user 39

Operations related to users

GET
/user
Retrieve information about the authenticated user
getUser → 200
PUT
/user
Update the authenticated user
updateUser body → 200400
GET
/user/subscriptions
Retrieve active subscriptions for the authenticated user
getUserSubscriptions → 200
GET
/user/teams
Retrieve a list of teams to which the authenticated user belongs
getUserTeams 2 params → 200
GET
/user/summary/grossCommission
Retrieve a summary of recent gross commission for the authenticated user
getUserSummaryGrossCommission → 200
GET
/user/upcomingOfferConditions
Retrieve a list of upcoming offer conditions for the authenticated user
getUserUpcomingOfferConditions 3 params → 200
GET
/user/upcomingOpenHomes
Retrieve a list of upcoming open homes for the authenticated user
getUserUpcomingOpenHomes 4 params → 200
PUT
/user/credentials
Update the credentials for the authenticated user
updateUserCredentials body → 200400
GET
/user/signature
Retrieve the authenticated user's signature
getUserSignature → 200
PUT
/user/signature
Update the signature for the authenticated user
updateUserSignature body → 200400
GET
/user/photo
Retrieve the authenticated user's photograph
getUserPhoto → 200
PUT
/user/photo
Update the photo for the authenticated user
updateUserPhoto body → 200400
GET
/account
Retrieve information about the authenticated account
getAccount → 200
GET
/account/users
Retrieve a list of users in the authenticated account
getAccountUsers 5 params → 200
POST
/account/users
Add a new user in the authenticated account
addUser body → 201400
GET
/account/users/{id}
Retrieve a single user from the account
getAccountUser 1 param → 200
PUT
/account/users/{id}
Update a user in the authenticated account
updateUser 1 param body → 200400
DELETE
/account/users/{id}
Delete a user in the authenticated account
deleteUser 1 param → 204400
GET
/account/users/{id}/teams
Retrieve a list of teams to which this user belongs
getAccountUserTeams 4 params → 200
GET
/account/teams
Retrieve a list of teams in the authenticated account
getAccountTeams 4 params → 200
GET
/account/teams/{id}
Retrieve a single team from the account
getAccountTeam 1 param → 200
GET
/account/enquirySources
Retrieve a list of enquiry sources in the authenticated account
getAccountEnquirySources 2 params → 200
POST
/account/enquirySources
Add a new Enquiry Source type
addEnquirySource body → 201400
GET
/account/enquirySources/{id}
Retrieve a single enquiry source
getAccountEnquirySource 1 param → 200
PUT
/account/enquirySources/{id}
Update an Enquiry Source type
updateEnquirySource 1 param body → 200400
GET
/account/pricing
Retrieve pricing information for the authenticated account
getAccountPricing → 200
DELETE
/logout
Log out from the current user session
logout → 204
POST
/verifyPassword
Verify the authenticated user's password
verifyUserPassword body → 200400
GET
/user/tenancyInspections
Retrieve a list of upcoming and recent inspections for the authenticated user
getUserTenancyInspections 6 params → 200
GET
/account/upcomingOpenHomes
Retrieve a list of upcoming open homes for the authenticated account
getAccountUpcomingOpenHomes 4 params → 200
GET
/account/folders/filingCabinet
Retrieve a list of folders available in the Filing Cabinet for this account
getAccountFilingCabinetFolders 4 params → 200
GET
/account/branches
Retrieve a list of branches configured for this account
getAccountBranches 2 params → 200
GET
/account/propertyPortals
Retrieve a list of property portals for this account
getAccountPortals 2 params → 200
GET
/account/trustAccounts
Retrieve a list of trust accounts for this account
getTrustAccounts 2 params → 200
GET
/sso
Generate a single-sign-on URL
getSSOUrl → 200
GET
/account/contactDateTypes
Retrieve a list of available contact date types for this account
getContactDateTypes 4 params → 200
GET
/user/oAuthLoginUrl
Get the oAuth sign-in target URL for this username
getOAuthLoginUrl 1 param → 200
GET
/account/oAuthLoginUrl
Get the oAuth sign-in target URL for this username (office level oAuth exchange)
getOAuthLoginUrlAccount 1 param → 200
GET
/account/customRegions
Retrieve a list of custom regions for this account
getCustomRegions 4 params → 200

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are User_3 (20 properties), Account_3 (16 properties), Account_2 (15 properties), User_2 (14 properties). Each schema is shown below with its type and property counts.

UserSubscriptions
object
1 property
AccountPricingUnit
object
2 properties
State
object
3 properties
Country
object
4 properties
AccountPricing
object
1 property
EnquirySource
object
2 properties
User
object
13 properties
PhoneNumber
object
3 properties
AddUpdateEnquirySource
object
1 property
Account
object
10 properties
Address
object
7 properties
AccountFranchise
object
2 properties
Suburb
object
4 properties
Signature
object
1 property
UpdateUser
object
5 properties
UserPhoto
object
2 properties
Team
object
2 properties
SuccessOrError
object
3 properties
Credential
object
2 properties
UserSubscriptions_2
object
2 properties
User_2
object
14 properties
PhoneNumber_2
object
4 properties
Account_2
object
15 properties
UpdateUser_2
object
6 properties
MarketingUserOrder
object
2 properties
UserSubscriptions_3
object
2 properties
ID
object
1 property
PropertyFileFolder
object
3 properties
ContactDateType
object
3 properties
OpenHome
object
6 properties
Portal
object
2 properties
Region
object
2 properties
UserAndTeams
Urls
object
3 properties
CustomRegion
object
2 properties
User_3
object
20 properties
PhoneNumber_3
object
4 properties
CustomAddress
object
4 properties
PortalAccess
object
4 properties
Account_3
object
16 properties
PropertyClass
object
3 properties
InspectionWithProperty
object
9 properties
Address_2
object
9 properties
PropertyOfferCondition
object
5 properties
Suburb_2
object
6 properties
District
object
3 properties
RoyalMail
object
13 properties
UpdateUser_3
object
6 properties
PropertyOfferConditionWithProperty
TrustAccount
object
5 properties
AccountBranch
object
5 properties
OpenHomeWithProperty
Access
object
4 properties
OfferCondition
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaultre-user-api-openapi.yml Raw ↑

Other APIs VaultRE publishes across the network.

VaultRE Advertising API
VaultRE Aml API
VaultRE Buildings API
VaultRE Bulk API
VaultRE Business Properties API
VaultRE Calendar API
VaultRE Campaigns API
VaultRE Categories API
VaultRE Clearing Sales Properties API
VaultRE Commercial Properties API
VaultRE Conjunctionals API
VaultRE Contacts API
Where this information came from

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