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

Operations related to franchise and user messages

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

Tagged areas include Message. 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 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: 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 9 schemas 7 GET4 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 Messages 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 — 7 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

messages 12

Operations related to franchise and user messages

GET
/messages/received
Retrieve all received messages
getMessagesReceived → 200
GET
/messages/sent
Retrieve all sent messages
getMessagesSent → 200
GET
/threads
Retrieve all message threads
getMessagesThreads → 200
POST
/threads/franchise
Add a franchise thread
addThreadFranchise body → 201400
POST
/threads/user
Add a user message thread
addThreadUser body → 201400
PUT
/threads/{id}
Update a message thread
updateMessageThread 1 param body → 200400
GET
/threads/{id}/messages
Retrieve all messages in a thread
getThreadMessages → 200
POST
/threads/{id}/messages
Add a message to a thread
addThreadMessage 1 param body → 201400
POST
/threads/{id}/markRead
Mark all messages in a thread as read by the current user
putMessageThreadRead 1 param → 200400
GET
/search/threads/recipients
Get all threads with the supplied recipients
getSearchThreadsRecipients 5 params → 200400
GET
/search/threads/staffTypes
Get all threads with the supplied recipients
getSearchThreadsStaffTypes 5 params → 200400
GET
/search/threads/term
Search for message threads containing term
getSearchThreadsTerm 5 params → 200400

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are MessageThread (9 properties), Message (7 properties), Access_2 (4 properties), Access (3 properties). Each schema is shown below with its type and property counts.

MessageReceipt
object
3 properties
MessageThread
object
9 properties
UserPhoto
object
2 properties
MessageRecipient
object
3 properties
SuccessOrError
object
3 properties
AddUpdateMessageThread
object
2 properties
Access
object
3 properties
Message
object
7 properties
Access_2
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaultre-messages-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 Messages 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.