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

Operations related to contacts

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

Tagged areas include Contacts. 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 70 operations across 46 paths, and defines 107 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.

70 operations 46 paths 107 schemas 9 DELETE31 GET18 POST12 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 Contacts 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 70

Across 46 paths, the API surfaces 70 operations — 9 DELETE, 31 GET, 18 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

contacts 70

Operations related to contacts

GET
/contacts
Retrieve a list of contacts
getContacts 7 params → 200
POST
/contacts
Create a contact
addContact body → 201400
GET
/contacts/{id}
Retrieve a single contact
getContact 1 param → 200
PUT
/contacts/{id}
Update a single contact
updateContact 1 param body → 200400
DELETE
/contacts/{id}
Delete a contact
deleteContact 1 param → 204400403
POST
/contacts/{id}/sms
Send an SMS to this contact
sendContactSMS body → 201400403
POST
/contacts/sms
Send multiple SMS messages to contacts
sendBulkContactSMS body → 201400403
GET
/contacts/{id}/context
Retrieve contextual information about this contact
getContactContext 1 param → 200
GET
/contacts/recentlyAccessed
Retrieve a list of recently accessed contacts
getRecentlyAccessedContacts → 200
GET
/contacts/{id}/notes
Retrieve a list of notes attached to this contact
getContactNotes 6 params → 200
POST
/contacts/{id}/notes
Add a note to this contact
addContactNote body → 201400
POST
/contacts/notes
Add multiple contact notes
addBulkContactNote body → 201400
GET
/contacts/{contactid}/notes/{id}
Retrieve a single contact note
getContactNote 2 params → 200
PUT
/contacts/{contactid}/notes/{id}
Update a contact note
updateContactNote 2 params body → 200400403
DELETE
/contacts/{contactid}/notes/{id}
Delete a contact note
deleteContactNote 2 params → 204400403
GET
/contacts/{id}/categories
Retrieve a list of categories to which this contact belongs
getCategoriesContact 5 params → 200
PUT
/contacts/{id}/categories
Update the categories to which this contact belongs
updateCategoriesContact 1 param body → 200400
POST
/contacts/{id}/categories
Attach a category to this contact
attachCategoryContact 1 param body → 200400
GET
/contacts/{id}/custom
Retrieve a list of custom fields for this contact
getContactCustomFields 3 params → 200
PUT
/contacts/{id}/custom
Update the custom fields for this contact
updateContactCustomFields 1 param body → 200400
GET
/contacts/{id}/files
Retrieve a list of files attached to this contact
getContactFiles 5 params → 200
POST
/contacts/{id}/files
Attach a file to this contact
addContactFile 1 param body → 201400
GET
/contacts/{id}/events
Retrieve a list of calendar events attached to this contact
getContactEvents 5 params → 200
PUT
/contacts/{id}/touch
Mark the contact record as touched
touchContact 1 param → 200400
GET
/contacts/{id}/requirements
Retrieve a list of buying/renting requirements for this contact
getContactRequirements 5 params → 200
POST
/contacts/{id}/requirements
Add a requirement for this contact
addContactRequirement 1 param body → 201400
GET
/contacts/{contactid}/requirements/{id}
Retrieve a single buying/renting requirement for this contact
getContactRequirement 2 params → 200
PUT
/contacts/{contactid}/requirements/{id}
Update a requirement for this contact
updateContactRequirement 2 params body → 200400
DELETE
/contacts/{contactid}/requirements/{id}
Delete a buying/renting requirement for the contact
deleteContactRequirement 2 params → 204400
GET
/properties/{id}/sale/{lifeid}/owners
Retrieve a list of owners attached to this property life
getPropertyLifeOwners 4 params → 200
PUT
/properties/{id}/sale/{lifeid}/owners
Update owners for this property life
updateOwnersForProperty 2 params body → 200400
POST
/properties/{id}/sale/{lifeid}/owners
Attach an owner to this property life
attachOwnerToProperty 2 params body → 200400
GET
/properties/{id}/lease/{lifeid}/landlords
Retrieve a list of landlords attached to this property life
getPropertyLifeLandlords 4 params → 200
PUT
/properties/{id}/lease/{lifeid}/landlords
Update landlords for this property life
updateLandlordsForProperty 2 params body → 200400
POST
/properties/{id}/lease/{lifeid}/landlords
Attach a landlord to this property life
attachLandlordToProperty 2 params body → 200400
GET
/properties/{id}/sale/{lifeid}/purchasers
Retrieve a list of purchasers attached to this property life
getPropertyLifePurchasers 4 params → 200
PUT
/properties/{id}/sale/{lifeid}/purchasers
Update purchasers for this property life
updatePurchasersForProperty 2 params body → 200400
POST
/properties/{id}/sale/{lifeid}/purchasers
Attach a purchaser to this property life
attachPurchaserToProperty 2 params body → 200400
GET
/properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants
Retrieve a list of tenants attached to this tenancy
getPropertyLifeTenancyTenants 5 params → 200
PUT
/properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants
Update tenants for this tenancy
updateTenantsForProperty 3 params body → 200400
POST
/properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants
Attach a tenant to this tenancy
attachTenantToTenancy 3 params body → 200400
POST
/contacts/{id}/email
Send an email to this contact
sendContactEmail body → 201400403
POST
/contacts/email
Send multiple emails to contacts
sendBulkContactEmail body → 201400403
PUT
/contacts/{id}/categories/remove
Remove categories from this contact
removeCategoryContact 1 param body → 200400
POST
/contacts/{id}/files/upload
Attach a file to this contact
addContactFileUpload 1 param body → 201400
GET
/contacts/{contactid}/files/{id}
Retrieve a single file attached to this contact
getContactFile 2 params → 200
DELETE
/contacts/{contactid}/files/{id}
Delete a file attached to this contact
deleteContactFile 2 params → 204400
DELETE
/properties/{propertyid}/lease/{lifeid}/landlords/{id}
Remove a landlord from this property life
deleteLandlordForProperty 3 params → 204400
DELETE
/properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/tenants/{id}
Remove a tenant from this property life
deleteTenantForProperty 4 params → 204400
DELETE
/properties/{propertyid}/sale/{lifeid}/owners/{id}
Remove an owner from this property life
deleteOwnerForProperty 3 params → 204400
DELETE
/properties/{propertyid}/sale/{lifeid}/purchasers/{id}
Remove a purchaser from this property life
deletePurchaserForProperty 3 params → 204400
GET
/contacts/requirements
Retrieve a list of buying/renting requirements across all contacts
getContactRequirementsBulk 7 params → 200
GET
/contacts/marketingUsers
Retrieve a list of contact marketing users across all contacts
getContactMarketingUsersBulk 6 params → 200
GET
/contacts/currentTenants
Retrieve a list of current tenants across all properties
getCurrentTenants 2 params → 200
GET
/contacts/currentLandlords
Retrieve a list of current landlords across all properties
getCurrentLandlords 2 params → 200
GET
/contacts/currentOwners
Retrieve a list of current owners/vendors across all sale properties
getCurrentOwners 2 params → 200
GET
/contacts/currentPurchasers
Retrieve a list of current purchasers across all sale properties
getCurrentPurchasers 2 params → 200
GET
/contacts/categories
Retrieve a list of contact category mappings across all contacts
getCategoriesContactBulk 6 params → 200
POST
/contacts/{id}/access
Allow a user to access this contact
addContactAccess body → 200400
GET
/contacts/{id}/activityLog
Retrieve the activity log for a contact
getContactActivityLog 3 params → 200
GET
/contacts/sourceOfEnquiry
Retrieve a list of contact source of enquiry across all contacts
getContactSourceOfEnquiryBulk 6 params → 200
GET
/contacts/dates
Retrieve a list of contact dates across all contacts
getContactDatesBulk 6 params → 200
GET
/contacts/{contactid}/bankAccounts/default
Retrieve the default bank account for this contact
getDefaultContactBankAccount 1 param → 200403404
PUT
/contacts/{contactid}/bankAccounts/default
Update the contact's default bank account
updateDefaultContactBankAccount 1 param body → 200400403
DELETE
/contacts/{contactid}/bankAccounts/default
Delete the default bank account for this contact
deleteDefaultContactBankAccount 1 param → 204403
GET
/contacts/{contactid}/dates
Retrieve a list of dates for this contact
getContactDates 3 params → 200
GET
/contacts/{contactid}/merged
Retrieve a list of contact ID's merged to this contact
getContactMergedDuplicates 3 params → 200
GET
/contacts/{contactid}/gdpr
Retrieve GDPR consent records for a contact
getContactGdprOptins 5 params → 200404
POST
/contacts/matchingRequirement/count
Get a count of contacts matching the provided buy/lease requirement
getMatchingContactsCount body → 200
POST
/contacts/merge
Submit a request for two contacts to be merged
mergeContacts body → 202

Schemas 107

The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are Contact_3 (29 properties), Contact_2 (25 properties), UpdateContact_3 (24 properties), Contact (22 properties). Each schema is shown below with its type and property counts.

ContactNoteTypePurpose
object
2 properties
ID
object
1 property
State
object
3 properties
Country
object
4 properties
UpdateContactNote
object
4 properties
ContactRequirement
object
17 properties
BulkContactNote
object
4 properties
AddUpdateContactRequirement
object
14 properties
ContactNoteType
object
5 properties
LinkedProperty
object
8 properties
EnquirySource
object
2 properties
AddContact
AddContactNote
object
5 properties
ContactNoteReminder
object
2 properties
ContactNote
object
8 properties
User
object
13 properties
UpdateContact
object
18 properties
PhoneNumber
object
3 properties
PropertyPhoto
object
13 properties
PropertyClass
object
2 properties
Address
object
7 properties
Suburb
object
4 properties
ContactExtended
Contact
object
22 properties
Category
object
2 properties
Unsubscribe
object
3 properties
AreaRange
object
3 properties
UpdateAddress
object
5 properties
PropertyType
object
4 properties
SMS
object
2 properties
UserPhoto
object
2 properties
PropertyPhotoThumbnails
object
2 properties
SuccessOrError
object
3 properties
Access
object
3 properties
ContactContext
object
7 properties
AddContactNoteReminder
object
2 properties
UpdateContactNote_2
object
5 properties
ContactRequirement_2
object
19 properties
AddUpdateMarketingUser
object
2 properties
BulkContactNote_2
object
5 properties
FileToBeUploaded
object
2 properties
AddUpdateContactRequirement_2
object
16 properties
ContactNoteType_2
object
6 properties
EntityType
object
2 properties
LinkedProperty_2
object
9 properties
AddContact_2
AddContactNote_2
object
6 properties
User_2
object
14 properties
ContactNote_2
object
10 properties
UpdateContact_2
object
20 properties
PhoneNumber_2
object
4 properties
Email
object
5 properties
PropertyClass_2
object
3 properties
PropertyFeedback
object
8 properties
Contact_2
object
25 properties
MarketingUser
object
2 properties
ContactNoteExtended
PropertyType_2
object
3 properties
ContactFile
object
9 properties
SMS_2
object
3 properties
ContactFileUpload
object
3 properties
CalendarEvent
object
13 properties
UpdateContactNote_3
object
5 properties
RequirementAndContact
object
2 properties
ContactRequirement_3
object
19 properties
ContactDateType
object
3 properties
Region
object
2 properties
CustomField
object
4 properties
BulkContactNote_3
object
5 properties
AddUpdateContactRequirement_3
object
16 properties
Urls
object
3 properties
ContactNoteType_3
object
6 properties
LinkedProperty_3
object
10 properties
Access_2
object
4 properties
AddContact_3
BulkEmail
object
5 properties
UnsubscribeType
object
2 properties
AddContactNote_3
object
7 properties
CustomFieldGrouping
object
2 properties
User_3
object
20 properties
ContactNote_3
object
10 properties
UpdateContact_3
object
24 properties
PhoneNumber_3
object
4 properties
GdprOptin
object
9 properties
MergeContactRequest
object
2 properties
AddUpdateCustomField
object
2 properties
CustomAddress
object
4 properties
ContactBankAccount
object
4 properties
PropertyClass_3
object
3 properties
Address_2
object
9 properties
PropertyFeedback_2
object
8 properties
BulkSMS
object
3 properties
Suburb_2
object
6 properties
District
object
3 properties
RoyalMail
object
13 properties
Contact_3
object
29 properties
CalendarContact
object
2 properties
ContactAndDate
ContactNoteExtended_2
PropertyType_3
object
3 properties
ContactDate
object
4 properties
AddUpdateContactBankAccount
object
3 properties
ContactFile_2
object
9 properties
SMS_3
object
3 properties
ContactAndMarketingUser
object
2 properties
BulkContactSourceOfEnquiry
object
4 properties
MatchingContactsRequest
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaultre-contacts-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 Corelogic API
Where this information came from

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