A distinct set of endpoints that operate at the integrator level rather than at an individual agency-account level, letting an approved integrator enumerate the accounts that have granted it an access token, list users on those accounts, validate a user, read granted scopes, list tokens, retrieve account-scoped merge fields, and read its own API usage. These endpoints replace the customer-supplied Bearer token with a short-lived HS512 JWT the integrator signs itself, carrying its API key and a current epoch timestamp and valid for 300 seconds, alongside the same X-Api-Key header.
VaultRE Integrator API is one of 3 APIs that VaultRE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Integrator, Account, Scopes, and Usage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
453 operations
across 324 paths,
organized into 44 resource areas,
and defines 356 schemas.
It is described by OpenAPI 3.0.1, at version 1.3.
Requests are made against a single base URL, https://ap-southeast-2.api.vaultre.com.au/api/v1.3.
453 operations324 paths356 schemas29 DELETE282 GET72 POST70 PUT
Metadata
The identity and technical contract details declared by the specification.
VaultRE Integrator API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-Api-Key (Api-Key).
It accepts HTTP bearer tokens (Bearer).
Paths & Operations 453
Across 324 paths, the API surfaces 453 operations — 29 DELETE, 282 GET, 72 POST, 70 PUT. They span 44 resource areas, including eventStream, integrator, types, buildings, categories, contacts, user, properties, and 36 more. Each is listed below with its method, path, parameters, and response codes.
eventStream 1
Operations related to the event stream
GET
/eventStream
Poll the event stream
getEventStream2 params→ 200
integrator 12
Special endpoints for access by integrating partners
GET
/integrator/accounts
Retrieve a list of accounts linked to this integrator
getIntegratorAccounts4 params→ 200
GET
/integrator/accounts/{id}
Retrieve an account linked to this integrator
getIntegratorAccount1 param→ 200
GET
/integrator/accounts/{id}/users
Retrieve a list of users for this account
getIntegratorAccountUsers6 params→ 200
GET
/integrator/accounts/{accountid}/users/{id}
Retrieve a user for this account
getIntegratorAccountUser2 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
Retrieve a list of contact distribution lists for this account
getContactDistributionLists5 params→ 200
GET
/distributionLists/contact/{id}
Retrieve a single contact distribution list
getContactDistributionList1 param→ 200
openhomes 1
Operations related to open homes
GET
/openHomes
Retrieve a list of property open homes
getAccountOpenHomes6 params→ 200
precincts 2
Operations related to precincts
GET
/precincts
Retrieve a list of precincts for this account
getAccountPrecincts4 params→ 200
GET
/precincts/{id}
Retrieve a single precinct
getPrecinct1 param→ 200
livestockProperties 5
Operations related to livestock properties
GET
/properties/livestock/sale/sold
Retrieve a list of sold livestock properties
getLivestockSoldProperties28 params→ 200
GET
/properties/livestock/sale
Retrieve a list of livestock properties
getLivestockProperties24 params→ 200
POST
/properties/livestock/sale
Add a livestock property
addLivestockPropertybody→ 201400
GET
/properties/livestock/sale/{id}
Retrieve a single livestock property
getLivestockProperty1 param→ 200
PUT
/properties/livestock/sale/{id}
Update a livestock property
updateLivestockProperty1 parambody→ 200400
clearingSalesProperties 5
Operations related to clearing sales properties
GET
/properties/clearingSales/sale/sold
Retrieve a list of sold clearing sales properties
getClearingSalesSoldProperties28 params→ 200
GET
/properties/clearingSales/sale
Retrieve a list of clearing sales properties
getClearingSalesProperties24 params→ 200
POST
/properties/clearingSales/sale
Add a clearing sales property
addClearingSalesPropertybody→ 201400
GET
/properties/clearingSales/sale/{id}
Retrieve a single clearing sales property
getClearingSalesProperty1 param→ 200
PUT
/properties/clearingSales/sale/{id}
Update a clearing sales property
updateClearingSalesProperty1 parambody→ 200400
fmsleads 2
Operations related to FMS leads
GET
/fms/leads
Get a list of FMS leads
getFMSLeads2 params→ 200
POST
/fms/leads
Submit a new FMS lead
addFMSLeadbody→ 201400
propertyOffer 4
Operations related to property offers
GET
/propertyOffers
Retrieve a list of property offers for this account
getPropertyOffers8 params→ 200
POST
/propertyOffers
Add a property offer
addPropertyOfferbody→ 201400
GET
/propertyOffers/{id}
Retrieve a single property offer
getPropertyOffer1 param→ 200
PUT
/propertyOffers/{id}
Update a property offer
updatePropertyOffer1 parambody→ 200400
campaigns 4
Operations related to marketing campaigns
GET
/campaigns
Retrieve a list of marketing campaigns for this account
getCampaigns2 params→ 200
GET
/campaigns/{id}
Retrieve a single marketing campaign
getCampaign1 param→ 200
GET
/campaigns/{id}/tracking
Retrieve a campaign tracking data
getCampaignTracking1 param→ 200
GET
/campaigns/{id}/tracking/summary
Retrieve campaign stats (totals)
getCampaignTrackingSummary1 param→ 200
conjunctionals 1
Operations related to conjunctional property deals
GET
/conjunctionals
Retrieve a list of conjunctional property deals for this account
getConjunctionals8 params→ 200
invoices 1
Operations related to invoices
GET
/invoices/saleSummary
Retrieve sale summary
getSaleSummary3 params→ 200
reinz 1
Operations related to REINZ
GET
/reinz/sales
Retrieve a list of sales sent to REINZ
getReinzSales9 params→ 200
aml 7
Operations related to AML checks
GET
/aml
Retrieve a list of AML checks
getAMLChecks5 params→ 200
POST
/aml
Create a new AML check for a contact
addAMLCheckbody→ 201400
GET
/aml/{id}
Retrieve a single AML check
getAMLCheck1 param→ 200
PUT
/aml/{id}
Update an existing AML check
updateAMLCheck1 parambody→ 200400
POST
/aml/{id}/notes
Add a new note to the AML check
addAMLNote1 parambody→ 201400
DELETE
/aml/{amlid}/files/{id}
Remove an attached file from an AML check
removeAMLNote2 params→ 204
POST
/aml/{id}/files/upload
Attach a file to this AML check
addAMLFile1 parambody→ 201400
Schemas 356
The contract defines 356 schemas that model the data the API accepts and returns. The most detailed are SaleHistory (44 properties), SaleProperty (42 properties), Property (37 properties), AddUpdateProperty (29 properties). Each schema is shown below with its type and property counts.
AuthToken
object
1 property
TemporaryToken
object
1 property
AccountBranch
object
5 properties
MarketingUser
object
2 properties
AddUpdateMarketingUser
object
2 properties
Contact
object
29 properties
ContactExtended
PhoneNumber
object
4 properties
Country
object
4 properties
Region
object
2 properties
District
object
3 properties
State
object
3 properties
Suburb
object
6 properties
RoyalMail
object
13 properties
CustomAddress
object
4 properties
Address
object
9 properties
UpdateAddress
object
5 properties
Unsubscribe
object
3 properties
Credential
object
2 properties
TwoFactorCredential
object
2 properties
ID
object
1 property
LocationHeader
string
The location of the newly created resource
SuccessOrError
object
3 properties
ResponseCode
object
2 properties
Urls
object
3 properties
ContactNoteTypePurpose
object
2 properties
ContactNoteType
object
6 properties
PropertyNoteTypePurpose
object
2 properties
PropertyNoteType
object
4 properties
Account
object
16 properties
MarketingUserOrder
object
2 properties
ContactPhoto
object
1 property
UserPhoto
object
2 properties
User
object
20 properties
UserAndTeams
ContactNote
object
10 properties
ContactNoteExtended
ContactNoteAndContact
object
2 properties
ContactNoteAndContactExtended
object
2 properties
ContactNoteReminder
object
2 properties
AddContactNoteReminder
object
2 properties
UpdateContactNote
object
5 properties
GdprOptin
object
9 properties
AddUpdatePropertyFeedback
object
4 properties
UpdateContactNoteWithFeedback
AddContactNote
object
7 properties
AddContactNoteWithFeedback
AddPropertyFeedback
object
2 properties
UpdatePropertyFeedback
object
1 property
PropertyNote
object
7 properties
UpdatePropertyNote
object
3 properties
AddPropertyNote
object
4 properties
CategoryGroupingSimple
object
2 properties
CategoryGrouping
object
3 properties
Category
object
2 properties
AddUpdateCategoryGrouping
object
1 property
AddUpdateCategory
object
1 property
Building
object
2 properties
AddUpdateBuilding
object
1 property
PropertyPhotoThumbnails
object
2 properties
PropertyPhoto
object
13 properties
Property
object
37 properties
PropertyLife
PropertyExtended
AddUpdateProperty
object
29 properties
ResidentialProperty
ResidentialPropertyExtended
AddUpdateResidentialProperty
SaleProperty
object
42 properties
AddUpdateSaleProperty
object
19 properties
MethodOfSale
object
2 properties
AuctionSaleType
object
2 properties
SoldType
object
2 properties
AuthorityType
object
2 properties
ResidentialSaleProperty
ResidentialSoldProperty
ResidentialSalePropertyExtended
ResidentialSoldPropertyExtended
LeaseProperty
object
16 properties
AddUpdateLeaseProperty
object
7 properties
ResidentialLeaseProperty
ResidentialLeasePropertyExtended
AddUpdateResidentialSaleProperty
AddUpdateResidentialLeaseProperty
LandProperty
LandSoldProperty
LandPropertyExtended
LandSoldPropertyExtended
AddUpdateLandProperty
RuralProperty
RuralSoldProperty
AddUpdateRuralProperty
RuralPropertyExtended
RuralSoldPropertyExtended
CommercialProperty
CommercialPropertyExtended
CommercialSaleProperty
CommercialSoldProperty
CommercialSalePropertyExtended
CommercialSoldPropertyExtended
CommercialLeaseProperty
CommercialLeasePropertyExtended
AddUpdateCommercialProperty
AddUpdateCommercialLeaseProperty
AddUpdateCommercialSaleProperty
BusinessProperty
BusinessSoldProperty
BusinessPropertyExtended
BusinessSoldPropertyExtended
AddUpdateBusinessProperty
HolidayRentalProperty
HolidayRentalPropertyExtended
AddUpdateHolidayRentalProperty
BuildingSearchResult
PropertySearchResult
object
13 properties
ContactSearchResult
object
9 properties
Rate
object
2 properties
Area
object
2 properties
AreaRange
object
3 properties
UpdateUser
object
6 properties
CustomFieldGrouping
object
2 properties
CustomField
object
4 properties
AddUpdateCustomField
object
2 properties
ActivityLog
object
4 properties
ContactFile
object
9 properties
CalendarEvent
object
13 properties
CalendarContact
object
2 properties
AddUpdateCalendarEvent
object
10 properties
PropertyFile
object
9 properties
PropertyFileWithFolders
PropertyFileFolder
object
3 properties
CoreLogicAddressSuggest
object
2 properties
CoreLogicProperty
object
10 properties
UpdateContact
object
24 properties
AddContact
Supplier
SupplierExtended
UpdateSupplier
object
22 properties
AddSupplier
ContactRequirement
object
19 properties
AddUpdateContactRequirement
object
16 properties
PropertyType
object
3 properties
PropertyClass
object
3 properties
Access
object
4 properties
Team
object
2 properties
CoreLogicAvm
object
4 properties
CoreLogicRentalAvm
object
6 properties
ContactContext
object
7 properties
LinkedProperty
object
10 properties
UserSubscriptions
object
2 properties
RentFrequency
object
2 properties
Tenancy
object
12 properties
PropertyFeedback
object
8 properties
Geolocation
object
3 properties
ExternalLinkType
object
2 properties
ExternalLink
object
4 properties
AddUpdateExternalLink
object
2 properties
OfferCondition
object
2 properties
PropertyOfferCondition
object
5 properties
UpdatePropertyOfferCondition
object
4 properties
PropertyOfferConditionWithProperty
Signature
object
1 property
AuctionDetails
object
3 properties
TenderDetails
object
1 property
SetSaleDateDetails
object
1 property
OpenHome
object
6 properties
AddUpdateOpenHome
object
4 properties
OpenHomeWithProperty
EnquirySource
object
2 properties
AddUpdateEnquirySource
object
1 property
BulkContactNote
object
5 properties
Task
object
10 properties
TaskContact
object
2 properties
AddTask
object
4 properties
UpdateTask
object
3 properties
PropertyFeatureGrouping
object
3 properties
UpdatePropertyFeatureGrouping
object
2 properties
PropertyFeature
object
4 properties
UpdatePropertyFeature
object
2 properties
Enquiry
object
18 properties
AddEnquiry
object
17 properties
SMS
object
3 properties
BulkSMS
object
3 properties
Email
object
5 properties
BulkEmail
object
5 properties
AccountPricingUnit
object
2 properties
AccountPricing
object
1 property
Token
object
3 properties
Metric
object
2 properties
UpdatePortalStatsTotal
object
5 properties
UpdatePortalStatsCumulative
PortalStats
object
9 properties
EmailTemplate
object
7 properties
AddUpdateEmailTemplate
object
5 properties
SMSTemplate
object
6 properties
AddUpdateSMSTemplate
object
4 properties
OwnerSummaryTemplate
object
6 properties
AddUpdateOwnerSummaryTemplate
object
4 properties
LeaseHistory
object
14 properties
SaleHistory
object
44 properties
PhotoTag
object
2 properties
AccountFranchise
object
2 properties
ContactInterest
object
2 properties
ContactMinimal
object
6 properties
PropertyLifeInterest
object
2 properties
PropertyLifeEnquirySource
object
2 properties
UpdatePropertyLifeEnquirySource
object
1 property
UpdatePropertyLifeInterest
object
1 property
RequirementAndContact
object
2 properties
ContactAndMarketingUser
object
2 properties
ContactAndCount
object
2 properties
PropertyFileWithFoldersUpload
object
4 properties
FileToBeUploaded
object
2 properties
Portal
object
2 properties
PortalAccess
object
4 properties
PropertyPhotoUpload
object
8 properties
ContactFileUpload
object
3 properties
MaintenancePhoto
object
4 properties
AddMaintenancePhoto
object
1 property
Maintenance
object
12 properties
AddMaintenance
object
6 properties
UpdateMaintenance
object
4 properties
MaintenanceRequest
object
8 properties
AddMaintenanceRequest
object
5 properties
MaintenanceNote
object
4 properties
Inspection
object
9 properties
AddInspection
object
6 properties
UpdateInspection
object
4 properties
Insurance
object
1 property
TrustAccount
object
5 properties
TrustLedgerTransactionType
object
2 properties
TrustLedgerCategory
object
2 properties
TrustLedgerTransaction
object
14 properties
TenancyExtended
TenancyAndProperty
object
2 properties
PropertyRoom
object
7 properties
ContactNoteWithContact
FlushProperty
object
4 properties
CommercialDeal
object
13 properties
CommercialDealSale
CommercialDealLease
CommissionSplitType
object
2 properties
PreDistributionDeduction
object
2 properties
OfficeDeduction
object
2 properties
OfficeReferral
object
1 property
CommissionSplitDeduction
object
2 properties
CommissionSplit
object
12 properties
FullSaleHistory
EntityType
object
2 properties
IntegratorPropertyStat
object
3 properties
UpdateIntegratorPropertyStats
object
1 property
InsertScheduledViewing
object
5 properties
MessageReceipt
object
3 properties
Message
object
7 properties
MessageRecipient
object
3 properties
MessageThread
object
9 properties
AddUpdateMessageThread
object
2 properties
InspectionWithProperty
object
9 properties
AdvertisingScheduleItem
object
4 properties
AdvertisingSchedule
object
2 properties
AdvertisingScheduleWithItems
AdvertisingAttachedScheduleItem
object
6 properties
AdvertisingAttachedSchedule
object
3 properties
AdvertisingAttachedScheduleWithItems
AdvertisingLedgerType
object
2 properties
AdvertisingPaymentType
object
2 properties
AdvertisingSupplier
object
2 properties
AddUpdateAdvertisingSupplier
object
1 property
AdvertisingExpenseType
object
6 properties
AdvertisingInvoice
object
12 properties
AdvertisingTransaction
object
16 properties
AddAdvertisingPayment
object
10 properties
PriceQualifier
object
2 properties
TenureOrTitleType
object
2 properties
HoldingAreaType
object
3 properties
MethodOfSaleType
object
2 properties
AuctionType
object
2 properties
PropertyKey
object
10 properties
AddUpdatePropertyKey
object
7 properties
ContactBankAccount
object
4 properties
AddUpdateContactBankAccount
object
3 properties
ContactDateType
object
3 properties
ContactDate
object
4 properties
ContactAndDate
DistributionList
object
2 properties
PropertyPortalId
object
2 properties
PropertyAlarmDetails
object
3 properties
UnsubscribeType
object
2 properties
Vertex
object
2 properties
Precinct
object
6 properties
FeesCharges
object
2 properties
ClearingSalesProperty
ClearingSalesSoldProperty
AddUpdateClearingSalesProperty
ClearingSalesPropertyExtended
ClearingSalesSoldPropertyExtended
LivestockProperty
LivestockSoldProperty
AddUpdateLivestockProperty
LivestockPropertyExtended
LivestockSoldPropertyExtended
FMSLeadContact
object
5 properties
FMSLeadProperty
object
7 properties
FMSLead
object
6 properties
AddFMSLead
object
5 properties
PropertyOfferStatus
object
2 properties
PropertyOffer
object
8 properties
AddPropertyOffer
object
7 properties
UpdatePropertyOffer
object
6 properties
BulkContactSourceOfEnquiry
object
4 properties
ConjunctionalSale
object
6 properties
ServiceChargeFrequency
object
2 properties
SharedOwnership
object
3 properties
Leasehold
object
9 properties
ServiceCharge
object
3 properties
PropertyListingConfiguration
object
10 properties
PropertyStrataProperty
PropertyProjectProperty
MatchingContactsRequest
object
8 properties
EventStreamItem
object
5 properties
Furnished
object
2 properties
AddPropertyActivityNote
object
3 properties
CampaignComments
object
5 properties
Campaign
object
6 properties
CampaignTracking
object
5 properties
CampaignTrackingSummary
object
6 properties
HazardsAndRisks
object
2 properties
ExternalFeedback
object
15 properties
InsertExternalFeedback
object
7 properties
UpdateExternalFeedback
object
5 properties
SaleSummary
object
8 properties
ReinzSale
object
6 properties
CustomRegion
object
2 properties
ExternalReference
object
2 properties
NZDistrict
object
3 properties
AMLStatus
object
2 properties
AMLNote
object
4 properties
AddAMLNote
object
1 property
AMLFile
object
5 properties
AddAMLFileUpload
object
2 properties
AMLProperty
object
7 properties
AddAMLProperty
object
3 properties
AMLCheck
object
12 properties
AddAMLCheck
object
2 properties
UpdateAMLCheck
object
1 property
PropertyPhotoOrderRequest
object
1 property1 required
PropertyPhotoOrderResponse
object
3 properties
PropertyPhotoBulkDeleteRequest
object
1 property1 required
PropertyPhotoBulkDeleteResult
object
4 properties3 required
PropertyPhotoBulkDeleteResponse
object
4 properties4 required
MergeContactRequest
object
2 properties
MergeField
object
8 properties2 required
MergeFieldCategory
object
4 properties3 required
MergeFieldTier
object
4 properties3 required
MergeFieldsTieredResponse
object
Returned when no context is provided. Shows all availability tiers.
2 properties2 required
MergeFieldsFlatResponse
object
Returned when a context is provided. Shows only fields usable in that context.
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘ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.