VaultRE

VaultRE Contacts API

Operations related to contacts

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 70

GET /contacts Retrieve a list of contacts #
POST /contacts Create a contact #
GET /contacts/{id} Retrieve a single contact #
PUT /contacts/{id} Update a single contact #
DELETE /contacts/{id} Delete a contact #
POST /contacts/{id}/sms Send an SMS to this contact #
POST /contacts/sms Send multiple SMS messages to contacts #
GET /contacts/{id}/context Retrieve contextual information about this contact #
GET /contacts/recentlyAccessed Retrieve a list of recently accessed contacts #
GET /contacts/{id}/notes Retrieve a list of notes attached to this contact #
POST /contacts/{id}/notes Add a note to this contact #
POST /contacts/notes Add multiple contact notes #
GET /contacts/{contactid}/notes/{id} Retrieve a single contact note #
PUT /contacts/{contactid}/notes/{id} Update a contact note #
DELETE /contacts/{contactid}/notes/{id} Delete a contact note #
GET /contacts/{id}/categories Retrieve a list of categories to which this contact belongs #
PUT /contacts/{id}/categories Update the categories to which this contact belongs #
POST /contacts/{id}/categories Attach a category to this contact #
GET /contacts/{id}/custom Retrieve a list of custom fields for this contact #
PUT /contacts/{id}/custom Update the custom fields for this contact #
GET /contacts/{id}/files Retrieve a list of files attached to this contact #
POST /contacts/{id}/files Attach a file to this contact #
GET /contacts/{id}/events Retrieve a list of calendar events attached to this contact #
PUT /contacts/{id}/touch Mark the contact record as touched #
GET /contacts/{id}/requirements Retrieve a list of buying/renting requirements for this contact #
POST /contacts/{id}/requirements Add a requirement for this contact #
GET /contacts/{contactid}/requirements/{id} Retrieve a single buying/renting requirement for this contact #
PUT /contacts/{contactid}/requirements/{id} Update a requirement for this contact #
DELETE /contacts/{contactid}/requirements/{id} Delete a buying/renting requirement for the contact #
GET /properties/{id}/sale/{lifeid}/owners Retrieve a list of owners attached to this property life #
PUT /properties/{id}/sale/{lifeid}/owners Update owners for this property life #
POST /properties/{id}/sale/{lifeid}/owners Attach an owner to this property life #
GET /properties/{id}/lease/{lifeid}/landlords Retrieve a list of landlords attached to this property life #
PUT /properties/{id}/lease/{lifeid}/landlords Update landlords for this property life #
POST /properties/{id}/lease/{lifeid}/landlords Attach a landlord to this property life #
GET /properties/{id}/sale/{lifeid}/purchasers Retrieve a list of purchasers attached to this property life #
PUT /properties/{id}/sale/{lifeid}/purchasers Update purchasers for this property life #
POST /properties/{id}/sale/{lifeid}/purchasers Attach a purchaser to this property life #
GET /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants Retrieve a list of tenants attached to this tenancy #
PUT /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants Update tenants for this tenancy #
POST /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants Attach a tenant to this tenancy #
POST /contacts/{id}/email Send an email to this contact #
POST /contacts/email Send multiple emails to contacts #
PUT /contacts/{id}/categories/remove Remove categories from this contact #
POST /contacts/{id}/files/upload Attach a file to this contact #
GET /contacts/{contactid}/files/{id} Retrieve a single file attached to this contact #
DELETE /contacts/{contactid}/files/{id} Delete a file attached to this contact #
DELETE /properties/{propertyid}/lease/{lifeid}/landlords/{id} Remove a landlord from this property life #
DELETE /properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/tenants/{id} Remove a tenant from this property life #
DELETE /properties/{propertyid}/sale/{lifeid}/owners/{id} Remove an owner from this property life #
DELETE /properties/{propertyid}/sale/{lifeid}/purchasers/{id} Remove a purchaser from this property life #
GET /contacts/requirements Retrieve a list of buying/renting requirements across all contacts #
GET /contacts/marketingUsers Retrieve a list of contact marketing users across all contacts #
GET /contacts/currentTenants Retrieve a list of current tenants across all properties #
GET /contacts/currentLandlords Retrieve a list of current landlords across all properties #
GET /contacts/currentOwners Retrieve a list of current owners/vendors across all sale properties #
GET /contacts/currentPurchasers Retrieve a list of current purchasers across all sale properties #
GET /contacts/categories Retrieve a list of contact category mappings across all contacts #
POST /contacts/{id}/access Allow a user to access this contact #
GET /contacts/{id}/activityLog Retrieve the activity log for a contact #
GET /contacts/sourceOfEnquiry Retrieve a list of contact source of enquiry across all contacts #
GET /contacts/dates Retrieve a list of contact dates across all contacts #
GET /contacts/{contactid}/bankAccounts/default Retrieve the default bank account for this contact #
PUT /contacts/{contactid}/bankAccounts/default Update the contact's default bank account #
DELETE /contacts/{contactid}/bankAccounts/default Delete the default bank account for this contact #
GET /contacts/{contactid}/dates Retrieve a list of dates for this contact #
GET /contacts/{contactid}/merged Retrieve a list of contact ID's merged to this contact #
GET /contacts/{contactid}/gdpr Retrieve GDPR consent records for a contact #
POST /contacts/matchingRequirement/count Get a count of contacts matching the provided buy/lease requirement #
POST /contacts/merge Submit a request for two contacts to be merged #

Documentation

📖
APIReference
https://docs.api.vaultre.com.au/swagger/index.html
📖
Documentation
https://docs.api.vaultre.com.au/guide.html
📖
GettingStarted
https://docs.api.vaultre.com.au/basics.html
📖
Authentication
https://docs.api.vaultre.com.au/oauth.html
📖
Documentation
https://docs.api.vaultre.com.au/webhooks.html
📖
Documentation
https://docs.api.vaultre.com.au/integrator.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/authentication/vaultre-authentication.yml
📖
APIReference
https://docs.api.vaultre.com.au/swagger/aggregator/index.html
📖
Documentation
https://docs.api.vaultre.com.au/aggregator.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/openapi/vaultre-contacts-api-openapi.yml

Code Examples

💻
CodeExamples
https://docs.api.vaultre.com.au/samples.html

Other Resources

🔗
ChangeLog
https://docs.api.vaultre.com.au/changelog.html
🔗
SourceCode
https://github.com/VaultGroup/api-samples
🔗
Webhooks
https://docs.api.vaultre.com.au/webhooks.html
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/data-model/vaultre-data-model.yml
🔗
SourceCode
https://github.com/VaultGroup/api-samples/blob/master/python/create_jwt.py
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/scopes/vaultre-scopes.yml
🔗
SourceCode
https://github.com/VaultGroup/api-samples/blob/master/aggregator/client.py
🔗
Webhooks
https://docs.api.vaultre.com.au/aggregator.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vaultre-contacts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vaultre-contacts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vaultre Contacts API
  contact:
    name: VaultRE
    url: https://www.vaultre.com.au
    email: api@vaultre.com.au
  version: '1.0'
  description: 'Operations tagged contacts across 3 of this provider''s published API definitions: vaultre-api-v1-1-openapi.yml, vaultre-api-v1-2-openapi.yml, vaultre-api-v1-3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
tags:


# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/openapi/vaultre-contacts-api-openapi.yml