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

Special endpoints for access by integrating partners

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

Tagged areas include Integrator. 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 12 operations across 11 paths, and defines 34 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.

12 operations 11 paths 34 schemas 9 GET2 POST1 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 Integrator 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 12

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

integrator 12

Special endpoints for access by integrating partners

GET
/integrator/accounts
Retrieve a list of accounts linked to this integrator
getIntegratorAccounts 4 params → 200
GET
/integrator/accounts/{id}
Retrieve an account linked to this integrator
getIntegratorAccount 1 param → 200
GET
/integrator/accounts/{id}/users
Retrieve a list of users for this account
getIntegratorAccountUsers 5 params → 200
GET
/integrator/accounts/{accountid}/users/{id}
Retrieve a user for this account
getIntegratorAccountUser 2 params → 200
GET
/integrator/scopes
Retrieve a list of possible scopes for your API key
getIntegratorScopes → 200
GET
/integrator/tokens
Retrieve a list of bearer tokens, with accounts, linked to this integrator
getIntegratorTokens 2 params → 200
GET
/scopes
Retrieve a list of granted scopes for this bearer token
getTokenScopes → 200
POST
/integrator/validateUser
Validate a user's credentials
validateIntegratorUser body → 200
PUT
/properties/{propertyid}/{salelease}/{lifeid}/externalStats
Integrator property statistics
updateExternalPropertyStats 3 params body → 200400
POST
/properties/{propertyid}/{salelease}/{lifeid}/externalStats
Integrator property statistics
updateExternalPropertyStat 3 params body → 200400
GET
/integrator/merge-fields
Retrieve available merge fields for an account
getIntegratorMergeFields 6 params → 200400404
GET
/integrator/usage
Retrieve daily quota for this API key
getUsage → 200

Schemas 34

The contract defines 34 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.

UserPhoto
object
2 properties
AccountFranchise
object
2 properties
State
object
3 properties
Suburb
object
4 properties
PhoneNumber
object
3 properties
User
object
13 properties
Country
object
4 properties
Account
object
10 properties
Address
object
7 properties
MarketingUserOrder
object
2 properties
SuccessOrError
object
3 properties
PhoneNumber_2
object
4 properties
UpdateIntegratorPropertyStats
object
1 property
User_2
object
14 properties
Account_2
object
15 properties
Credential
object
2 properties
IntegratorPropertyStat
object
3 properties
Urls
object
3 properties
MergeFieldTier
object
4 properties 3 required
MergeFieldCategory
object
4 properties 3 required
District
object
3 properties
Suburb_2
object
6 properties
CustomAddress
object
4 properties
RoyalMail
object
13 properties
Token
object
3 properties
MergeFieldsTieredResponse
object
Returned when no context is provided. Shows all availability tiers.
2 properties 2 required
MergeFieldsFlatResponse
object
Returned when a context is provided. Shows only fields usable in that context.
2 properties 2 required
Account_3
object
16 properties
ID
object
1 property
Region
object
2 properties
PhoneNumber_3
object
4 properties
MergeField
object
8 properties 2 required
User_3
object
20 properties
Address_2
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaultre-integrator-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 Integrator 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.