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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VaultRE

VaultRE API

The core VaultRE REST API - the open API a third-party developer integrates an agency website or application against. Version 1.3 documents 324 paths and 453 operations covering contacts, properties across every life type (residential, commercial, rural, land, business, holiday rental, livestock, clearing sales), listings and photos, enquiries, offers and offer conditions, open homes, feedback, appraisals, calendar and tasks, inspections, maintenance and suppliers, tenancies, invoices, deals, campaigns and advertising, templates, merge fields, SMS and email messaging, AML checks, keys, suburbs and precincts, an event-stream poll endpoint, CoreLogic property and AVM lookups, and REINZ sales reporting for New Zealand. Every request carries both an integrator X-Api-Key header and a per-account Bearer access token; the granted scopes on a token are readable from GET /scopes.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Contacts, Properties, Listings, Property Management, and Enquiries. 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 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 operations 324 paths 356 schemas 29 DELETE282 GET72 POST70 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.3
Base URL
https://ap-southeast-2.api.vaultre.com.au/api/v1.3
Authentication
API Key, HTTP Bearer
Contact
VaultRE
Resource Areas
44

Authentication & Security 2

VaultRE 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
getEventStream 2 params → 200
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 6 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 3 params → 200
POST
/integrator/validateUser
Validate a user's credentials
validateIntegratorUser body → 200
GET
/integrator/merge-fields
Retrieve available merge fields for an account
getIntegratorMergeFields 6 params → 200400404
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
/scopes
Retrieve a list of granted scopes for this bearer token
getTokenScopes → 200
GET
/integrator/usage
Retrieve daily quota for this API key
getUsage → 200
types 17

Operations related to various VaultRE object types

GET
/responseCodes
Retrieve a list of response codes used in this API
getResponseCodes → 200
GET
/types/propertyClass
Retrieve a list of property classes
getPropertyClasses 4 params → 200
GET
/types/propertyType
Retrieve a list of property types
getPropertyTypes 4 params → 200
GET
/types/customUnsubscribe
Retrieve a list of custom unsubscribe types
getCustomUnsubscribeTypes 4 params → 200
GET
/types/contactInterest
Retrieve a list of contact interest types
getContactInterestTypes 4 params → 200
GET
/types/entityTypes
Retrieve a list of contact entity types
getContactEntityTypes 4 params → 200
GET
/types/externalLinks
Retrieve a list of property external link types
getExternalLinkTypes 4 params → 200
GET
/types/contactnotes
Retrieve a list of contact note types for this account
getContactNoteTypes 4 params → 200
GET
/types/contactnotes/{id}
Retrieve a single contact note type
getContactNoteType 1 param → 200
GET
/types/propertynotes
Retrieve a list of property note types for this account
getPropertyNoteTypes 4 params → 200
GET
/types/propertynotes/{id}
Retrieve a single property note type
getPropertyNoteType 1 param → 200
GET
/types/priceQualifiers
Retrieve a list of price qualifier types
getPriceQualifierTypes 4 params → 200
GET
/types/tenureOrTitleTypes
Retrieve a list of tenure or title types
getTenureOrTitleTypes 4 params → 200
GET
/types/methodOfSale
Retrieve a list of method of sale types
getMethodOfSaleTypes 4 params → 200
GET
/types/auctionSale
Retrieve a list of Auction types
getAuctionTypes 4 params → 200
GET
/types/advertising/transactions
Retrieve a list of advertising transaction types
getAdvertisingTransactionTypes 4 params → 200
GET
/types/advertising/payments
Retrieve a list of advertising payment types
getAdvertisingPaymentTypes 4 params → 200
buildings 5

Operations related to buildings

GET
/buildings
Retrieve a list of buildings
getBuildings 4 params → 200
POST
/buildings
Create a building record
addBuilding body → 200201400
GET
/buildings/{id}
Retrieve a single building
getBuilding 1 param → 200
PUT
/buildings/{id}
Update the building
updateBuilding 1 param body → 200400
DELETE
/buildings/{id}
Delete the building
deleteBuilding 1 param → 204400
categories 14

Operations related to categories

GET
/categories/contact/groups
Retrieve a list of contact category groups
getContactCategoryGroups 4 params → 200
POST
/categories/contact/groups
Create a contact category grouping
addContactCategoryGroup body → 201400
GET
/categories/contact/groups/{id}
Retrieve a single contact category group
getContactCategoryGroup 1 param → 200
PUT
/categories/contact/groups/{id}
Update a contact category grouping
updateContactCategoryGroup 1 param body → 200400
GET
/categories/contact/groups/{id}/categories
Retrieve a list of categories in this contact category group
getContactCategoryGroupCategories 1 param → 200
POST
/categories/contact/groups/{id}/categories
Create a contact category in this grouping
addContactCategoryGroupCategory 1 param body → 201400
GET
/categories/contact/groups/{groupingid}/categories/{id}
Retrieve a single category in this contact category group
getContactCategoryGroupCategory 2 params → 200
PUT
/categories/contact/groups/{groupingid}/categories/{id}
Update a contact category in this grouping
updateContactCategoryGroupCategory 2 params body → 200400
GET
/categories/contact
Retrieve a list of contact categories
getContactCategories 4 params → 200
GET
/categories/contact/{id}
Retrieve a single contact category
getContactCategory 1 param → 200
GET
/categories/property/groups
Retrieve a list of property category groups
getPropertyCategoryGroups 4 params → 200
GET
/categories/property/groups/{id}
Retrieve a single property category group
getPropertyCategoryGroup 1 param → 200
GET
/categories/property
Retrieve a list of property categories
getPropertyCategories 4 params → 200
GET
/categories/property/{id}
Retrieve a single property category
getPropertyCategory 1 param → 200
contacts 54

Operations related to contacts

GET
/contacts
Retrieve a list of contacts
getContacts 13 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 1 param body → 201400403
POST
/contacts/sms
Send multiple SMS messages to contacts
sendBulkContactSMS body → 201400403
POST
/contacts/{id}/email
Send an email to this contact
sendContactEmail 1 param body → 201400403
POST
/contacts/email
Send multiple emails to contacts
sendBulkContactEmail 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 1 param → 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 1 param 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 one or more categories to this contact
attachCategoryContact 1 param body → 200400
PUT
/contacts/{id}/categories/remove
Remove categories from this contact
removeCategoryContact 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
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
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 6 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
/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 4 params → 200
GET
/contacts/currentLandlords
Retrieve a list of current landlords across all properties
getCurrentLandlords 4 params → 200
GET
/contacts/currentOwners
Retrieve a list of current owners/vendors across all sale properties
getCurrentOwners 4 params → 200
GET
/contacts/currentPurchasers
Retrieve a list of current purchasers across all sale properties
getCurrentPurchasers 4 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/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 1 param body → 200400
GET
/contacts/{id}/activityLog
Retrieve the activity log for a contact
getContactActivityLog 3 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
user 37

Operations related to users

GET
/user
Retrieve information about the authenticated user
getUser → 200
PUT
/user
Update the authenticated user
updateMeUser body → 200400
GET
/user/subscriptions
Retrieve active subscriptions for the authenticated user
getUserSubscriptions → 200
GET
/user/teams
Retrieve a list of teams to which the authenticated user belongs
getUserTeams 2 params → 200
GET
/user/summary/grossCommission
Retrieve a summary of recent gross commission for the authenticated user
getUserSummaryGrossCommission → 200
GET
/user/upcomingOfferConditions
Retrieve a list of upcoming offer conditions for the authenticated user
getUserUpcomingOfferConditions 3 params → 200
GET
/user/upcomingOpenHomes
Retrieve a list of upcoming open homes for the authenticated user
getUserUpcomingOpenHomes 4 params → 200
GET
/user/tenancyInspections
Retrieve a list of upcoming and recent inspections for the authenticated user
getUserTenancyInspections 6 params → 200
PUT
/user/credentials
Update the credentials for the authenticated user
updateUserCredentials body → 200400
GET
/user/signature
Retrieve the authenticated user's signature
getUserSignature → 200
PUT
/user/signature
Update the signature for the authenticated user
updateUserSignature body → 200400
GET
/user/photo
Retrieve the authenticated user's photograph
getUserPhoto → 200
PUT
/user/photo
Update the photo for the authenticated user
updateUserPhoto body → 200400
GET
/account
Retrieve information about the authenticated account
getAccount → 200
GET
/account/users
Retrieve a list of users in the authenticated account
getAccountUsers 6 params → 200
POST
/account/users
Add a new user in the authenticated account
addUser body → 201400
GET
/account/users/{id}
Retrieve a single user from the account
getAccountUser 1 param → 200
PUT
/account/users/{id}
Update a user in the authenticated account
updateUser 1 param body → 200400
DELETE
/account/users/{id}
Delete a user in the authenticated account
deleteUser 1 param → 204400
GET
/account/users/{id}/teams
Retrieve a list of teams to which this user belongs
getAccountUserTeams 5 params → 200
GET
/account/teams
Retrieve a list of teams in the authenticated account
getAccountTeams 4 params → 200
GET
/account/teams/{id}
Retrieve a single team from the account
getAccountTeam 1 param → 200
GET
/account/enquirySources
Retrieve a list of enquiry sources in the authenticated account
getAccountEnquirySources 2 params → 200
POST
/account/enquirySources
Add a new Enquiry Source type
addEnquirySource body → 201400
GET
/account/enquirySources/{id}
Retrieve a single enquiry source
getAccountEnquirySource 1 param → 200
PUT
/account/enquirySources/{id}
Update an Enquiry Source type
updateEnquirySource 1 param body → 200400
GET
/account/pricing
Retrieve pricing information for the authenticated account
getAccountPricing → 200
GET
/account/upcomingOpenHomes
Retrieve a list of upcoming open homes for the authenticated account
getAccountUpcomingOpenHomes 4 params → 200
GET
/account/folders/filingCabinet
Retrieve a list of folders available in the Filing Cabinet for this account
getAccountFilingCabinetFolders 4 params → 200
GET
/account/branches
Retrieve a list of branches configured for this account
getAccountBranches 2 params → 200
GET
/account/propertyPortals
Retrieve a list of property portals for this account
getAccountPortals 2 params → 200
GET
/account/trustAccounts
Retrieve a list of trust accounts for this account
getTrustAccounts 2 params → 200
POST
/verifyPassword
Verify the authenticated user's password
verifyUserPassword body → 200400
GET
/sso
Generate a single-sign-on URL
getSSOUrl → 200
GET
/account/contactDateTypes
Retrieve a list of available contact date types for this account
getContactDateTypes 4 params → 200
GET
/user/oAuthLoginUrl
Get the oAuth sign-in target URL for this username
getOAuthLoginUrl 1 param → 200
GET
/account/oAuthLoginUrl
Get the oAuth sign-in target URL for this username (office level oAuth exchange)
getOAuthLoginUrlAccount 1 param → 200
properties 117

Operations related to properties

GET
/properties
Retrieve a list of properties
getProperties 10 params → 200
GET
/properties/{id}
Retrieve a single property
getProperty 1 param → 200
DELETE
/properties/{id}
Delete a property
deleteProperty 1 param → 204400
GET
/properties/sale
Retrieve a list of sale properties
getPropertiesLifeSale 34 params → 200
GET
/properties/sale/fallenSaleWithdrawn
Retrieve a list of fallen or withdrawn property sales
getFallenWithdrawnSales 6 params → 200
GET
/properties/lease
Retrieve a list of lease properties
getPropertiesLifeLease 34 params → 200
GET
/properties/{id}/notes
Retrieve a list of notes attached to this property
getPropertyNotes 6 params → 200
POST
/properties/{id}/notes
Add a note to this property
addPropertyNote 1 param body → 201400
GET
/properties/{propertyid}/notes/{id}
Retrieve a single property note
getPropertyNote 2 params → 200
PUT
/properties/{propertyid}/notes/{id}
Update a property note
updatePropertyNote 2 params body → 200400403
DELETE
/properties/{propertyid}/notes/{id}
Delete a property note
deletePropertyNote 2 params → 204400403
GET
/properties/{id}/photos
Retrieve a list of photos for this property
getPropertyPhotos 3 params → 200
POST
/properties/{id}/photos
Upload a new photo to this property
addPropertyPhoto 1 param body → 201400
DELETE
/properties/{id}/photos
Delete multiple photos from this property
deletePropertyPhotos 1 param body → 200400403404422
POST
/properties/{id}/photos/upload
Upload a new photo to this property
addPropertyPhotoUpload 1 param body → 201400
PUT
/properties/{id}/photos/order
Reorder property photos
updatePropertyPhotoOrder 1 param body → 200400403404422
GET
/properties/{propertyid}/photos/{id}
Retrieve a single photo for this property
getPropertyPhoto 2 params → 200
PUT
/properties/{propertyid}/photos/{id}
Update photo metadata
updatePropertyPhoto 2 params body → 200400403404422500
DELETE
/properties/{propertyid}/photos/{id}
Delete a photo attached to this property
deletePropertyPhoto 2 params → 204400
GET
/properties/{propertyid}/photos/{id}/tags
Retrieve a list of tags for this property photo
getPropertyPhotoTags 8 params → 200
GET
/properties/{id}/tags
Retrieve a list of tags for this property
getPropertyTags 7 params → 200
GET
/properties/{id}/categories
Retrieve a list of categories to which this property belongs
getCategoriesForProperty 5 params → 200
GET
/properties/{id}/activityLog
Retrieve the activity log for a property
getPropertyActivityLog 3 params → 200
POST
/properties/{id}/activityLog
Add a property activity note
addPropertyActivityNote 1 param body → 201
GET
/properties/{id}/files
Retrieve a list of files attached to this property
getPropertyFiles 5 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/matchingContacts
Retrieve a list of contacts with requirements matching this property
getPropertyMatchingContacts 7 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/files
Retrieve a list of files attached to this property life
getPropertyFilesLife 8 params → 200
POST
/properties/{id}/{salelease}/{lifeid}/files
Attach a file to this property life
addPropertyFileLife 3 params body → 201400
POST
/properties/{id}/{salelease}/{lifeid}/files/upload
Attach a file to this property life
addPropertyFileLifeUpload 3 params body → 201400
GET
/properties/{propertyid}/{salelease}/{lifeid}/files/{id}
Retrieve a single file attached to this property life
getPropertyFileLife 4 params → 200
DELETE
/properties/{propertyid}/{salelease}/{lifeid}/files/{id}
Delete a single file attached to this property life
deletePropertyFileLife 4 params → 204400
GET
/properties/{id}/{salelease}/{lifeid}/feedback
Retrieve a list of property feedback attached to this life
getPropertyFeedbackLife 12 params → 200
POST
/properties/{id}/{salelease}/{lifeid}/feedback
Attach feedback to this property life
attachFeedbackToPropertyLife 3 params body → 201400
GET
/properties/{propertyid}/{salelease}/{lifeid}/feedback/{id}
Retrieve a property feedback item attached to this life
getSinglePropertyFeedbackLife 4 params → 200
PUT
/properties/{propertyid}/{salelease}/{lifeid}/feedback/{id}
Update a feedback item
updateFeedback 4 params body → 200400
DELETE
/properties/{propertyid}/{salelease}/{lifeid}/feedback/{id}
Delete a property feedback item
deletePropertyFeedback 4 params → 204400
GET
/properties/{id}/{salelease}/{lifeid}/feedback/summary
Retrieve a summary of property feedback feedback attached to this life
getPropertyFeedbackLifeSummary 11 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/openHomes
Retrieve a list of open homes attached to this life
getPropertyOpenHomes 10 params → 200
POST
/properties/{id}/{salelease}/{lifeid}/openHomes
Create a new open home for this property life
addOpenHome 3 params body → 201400
GET
/properties/{propertyid}/{salelease}/{lifeid}/openHomes/{id}
Retrieve a single open home attached to this life
getPropertyOpenHome 4 params → 200
PUT
/properties/{propertyid}/{salelease}/{lifeid}/openHomes/{id}
Update an open home for this property life
updateOpenHome 4 params body → 200400
DELETE
/properties/{propertyid}/{salelease}/{lifeid}/openHomes/{id}
Delete an open home
deleteOpenHome 4 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
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
/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
GET
/properties/{id}/features
Retrieve features for this property
getPropertyFeatures 1 param → 200
PUT
/properties/{id}/features
Update features for this property
updatePropertyFeatures 1 param body → 200400
GET
/properties/{class}/{salelease}/{id}/custom
Retrieve a list of custom fields for a given property
getPropertyCustomFields 5 params → 200
PUT
/properties/{class}/{salelease}/{id}/custom
Update the custom fields for this property
updatePropertyCustomFields 3 params body → 200400
GET
/properties/{id}/sale/{lifeid}/offerConditions
Retrieve a list of offer conditions for this property life
getPropertyLifeOfferConditions 7 params → 200
GET
/properties/{propertyid}/sale/{lifeid}/offerConditions/{id}
Retrieve an offer condition for this property life
getPropertyLifeOfferCondition 3 params → 200
PUT
/properties/{propertyid}/sale/{lifeid}/offerConditions/{id}
Update a property's offer condition
updatePropertyOfferCondition 3 params body → 200400
PUT
/properties/{propertyid}/sale/{lifeid}/offerConditions/{id}/complete
Complete a property's offer condition
completePropertyOfferCondition 3 params → 200400
PUT
/properties/{propertyid}/sale/{lifeid}/offerConditions/{id}/uncomplete
Uncomplete a property's offer condition
uncompletePropertyOfferCondition 3 params → 200400
GET
/properties/{class}/{salelease}/upcomingOpenHomes
Retrieve a list of upcoming open homes
getUpcomingOpenHomes 5 params → 200
GET
/properties/lookup/{propertyReference}
Look up property information based on property reference
lookupPropertyByPortalReference 1 param → 200
PUT
/properties/{id}/sale/statusChange/listing
Convert a prospect or appraisal sale property to listing status
convertToListing 1 param → 200400
PUT
/properties/{id}/lease/statusChange/management
Convert a prospect or appraisal lease property to management status
convertToManagement 1 param → 200400
GET
/properties/{id}/{salelease}/{lifeid}/interest
Retrieve a list of contacts and their interest related this property life
getPropertyLifeInterest 5 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/interest/{contactid}
Retrieve a single contact's interest in this property life
getPropertyLifeInterestItem 4 params → 200
PUT
/properties/{id}/{salelease}/{lifeid}/interest/{contactid}
Update a contact's interest in this property life
updatePropertyLifeInterest 4 params body → 200201400
GET
/properties/{id}/{salelease}/{lifeid}/enquirySources
Retrieve a list of contacts and their source of enquiry related this property life
getPropertyLifeEnquirySources 5 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/enquirySources/{contactid}
Retrieve a single contact's source of enquiry for this property life
getPropertyLifeEnquirySourcesItem 4 params → 200
PUT
/properties/{id}/{salelease}/{lifeid}/enquirySources/{contactid}
Update a contact's source of enquiry for this property life
updatePropertyLifeEnquirySource 4 params body → 200201400
GET
/properties/{propertyid}/lease/{lifeid}/maintenance
Retrieve a list of maintenance jobs for this property life
getMaintenance 8 params → 200
POST
/properties/{propertyid}/lease/{lifeid}/maintenance
Create a maintenance job
addMaintenance 2 params body → 201400
GET
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}
Retrieve a single maintenance job
getMaintenanceJob 3 params → 200
PUT
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}
Update a single maintenance job
updateMaintenance 3 params body → 200400
DELETE
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}
Delete a maintenance job
deleteMaintenance 3 params → 204400403
POST
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/photos
Add a maintenance job photo
addMaintenancePhoto 3 params body → 201400
GET
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/photos/{id}
Retrieve a single maintenance job photo
getMaintenanceJobPhoto 4 params → 200
DELETE
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/photos/{id}
Delete a maintenance job photo
deleteMaintenancePhoto 4 params → 204400403
GET
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests
Retrieve a list of requests for a maintenance job
getMaintenanceRequests 8 params → 200
POST
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests
Create a maintenance job request
addMaintenanceRequest 3 params body → 201400
PUT
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests/{id}/initiateWorkOrder
Initiate a maintenance work order
initiateMaintenceWorkOrder 4 params body → 200400
PUT
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests/{id}/complete
Complete a maintenance work order
completeMaintenceWorkOrder 4 params → 200400
GET
/properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/notes
Retrieve a list of notes for a maintenance job
getMaintenanceNotes 7 params → 200
GET
/properties/{propertyid}/lease/{lifeid}/tenancy/{id}/inspections
Retrieve a list of inspections for a tenancy
getInspections 8 params → 200
POST
/properties/{propertyid}/lease/{lifeid}/tenancy/{id}/inspections
Create an inspection
addInspection 3 params body → 201400
GET
/properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/inspections/{id}
Retrieve a single inspection for a tenancy
getInspection 4 params → 200
PUT
/properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/inspections/{id}
Update an inspection
updateInspection 4 params body → 200400
DELETE
/properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/inspections/{id}
Delete an inspection
deleteInspection 4 params → 204400
PUT
/property/flush
Trigger a property to be re-sent to certain portal sites
flushProperty body → 200400
GET
/properties/{propertyid}/saleHistory
Retrieve the full sale history for a property
getPropertySaleHistory 3 params → 200
POST
/properties/{propertyid}/{salelease}/{lifeid}/scheduledViewing
Add a Scheduled Viewing
addScheduledViewing 3 params body → 201400
GET
/properties/{propertyid}/{salelease}/{lifeid}/scheduledViewing
Retrieve a list of scheduled viewings for this life
getPropertyLifeScheduledViewings 11 params → 200
GET
/properties/categories
Retrieve a list of property category mappings across all properties
getCategoriesPropertyBulk 6 params → 200
GET
/properties/{propertyid}/sale/{lifeid}/trustledger/transactions
Retrieve a list of trust ledger transactions for this property sale life
getPropertyLifeTrustLedgerTransactions 4 params → 200400403
GET
/properties/{id}/{salelease}/{lifeid}/portals
Retrieve a list of portal sites to which this listing is published
getPropertyLifePortals 5 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/portalIds
Retrieve a list of property portal IDs
getPropertyLifePortalIds 5 params → 200
GET
/properties/{propertyid}/alarmDetails
Retrieve a list of alarm details for a property
getPropertyAlarmDetails 2 params → 200
GET
/properties/{propertyid}/{salelease}/alarmDetails
Retrieve a list of alarm details for a property life
getPropertyLifeAlarmDetails 2 params → 200
GET
/properties/{id}/{salelease}/{lifeid}/rooms
Retrieve a list of rooms defined for this property life
getPropertyLifeRooms 5 params → 200
GET
/properties/{id}/sale/{lifeid}/solicitors
Retrieve purchaser and vendor solicitors defined for this property life
getPropertySolicitors 2 params → 200
GET
/properties/externalRefs/lookup
Retrieve properties from an external reference
getPropertiesFromExternalReference 1 param → 200
GET
/properties/{propertyid}/listingConfigurations
Retrieve a list of listing configurations for the given property
getPropertyListingConfigurations 1 param → 200
GET
/properties/{propertyid}/strataProperties
Retrieve a list of strata properties for the given property
getPropertyStrataProperties 1 param → 200
GET
/properties/{propertyid}/projectProperties
Retrieve a list of project properties for the given property
getPropertyProjectProperties 1 param → 200
GET
/properties/{propertyid}/{salelease}/{lifeid}/qrcode
Retrieve a check-in QR code for the given property life
getPropertyLifeQrCode 3 params → 200
GET
/properties/{propertyid}/{salelease}/{lifeid}/hazards
Retrieve a list of hazards for a given property life
getPropertyLifeHazards 3 params → 200
GET
/properties/{propertyid}/{salelease}/{lifeid}/externalFeedback/{id}
Retrieve a single external feedback for a given property life
getPropertyLifeExternalFeedbackById 4 params → 200
PUT
/properties/{propertyid}/{salelease}/{lifeid}/externalFeedback/{id}
Update an external feedback for a given property life
updatePropertyLifeExternalFeedback 4 params body → 200400
GET
/properties/{propertyid}/{salelease}/{lifeid}/externalFeedback
Retrieve a list of external feedback for a given property life
getPropertyLifeExternalFeedback 3 params → 200
POST
/properties/{propertyid}/{salelease}/{lifeid}/externalFeedback
Add an External Feedback
addPropertyLifeExternalFeedback 3 params body → 201400
residentialProperties 13

Operations related to residential properties

GET
/properties/residential/sale
Retrieve a list of residential sale properties
getResidentialSaleProperties 24 params → 200
POST
/properties/residential/sale
Add a residential sale property
addResidentialSaleProperty body → 201400
GET
/properties/residential/sale/available
Retrieve a list of available residential sale properties
getAvailableResidentialSaleProperties 14 params → 200
GET
/properties/residential/sale/{id}
Retrieve a single residential sale property
getResidentialSaleProperty 1 param → 200
PUT
/properties/residential/sale/{id}
Update a residential sale property
updateResidentialSaleProperty 1 param body → 200400
GET
/properties/residential/sale/sold
Retrieve a list of sold residential sale properties
getResidentialSoldProperties 34 params → 200
GET
/properties/residential/lease
Retrieve a list of residential lease properties
getResidentialLeaseProperties 29 params → 200
POST
/properties/residential/lease
Add a residential lease property
addResidentialLeaseProperty body → 201400
GET
/properties/residential/lease/available
Retrieve a list of available residential lease properties
getAvailableResidentialLeaseProperties 14 params → 200
GET
/properties/residential/lease/{id}
Retrieve a single residential lease property
getResidentialLeaseProperty 1 param → 200
PUT
/properties/residential/lease/{id}
Update a residential lease property
updateResidentialLeaseProperty 1 param body → 200400
GET
/properties/residential/sale/{id}/{lifeid}
Retrieve a single residential sale property
getResidentialSalePropertyAndLife 2 params → 200
GET
/properties/residential/lease/{id}/{lifeid}
Retrieve a single residential lease property
getResidentialLeasePropertyAndLife 2 params → 200
landProperties 7

Operations related to land properties

GET
/properties/land/sale
Retrieve a list of land properties
getLandProperties 26 params → 200
POST
/properties/land/sale
Add a land property
addLandProperty body → 201400
GET
/properties/land/sale/available
Retrieve a list of available land properties
getAvailableLandProperties 14 params → 200
GET
/properties/land/sale/{id}
Retrieve a single land property
getLandProperty 1 param → 200
PUT
/properties/land/sale/{id}
Update a land property
updateLandProperty 1 param body → 200400
GET
/properties/land/sale/sold
Retrieve a list of sold land properties
getLandSoldProperties 28 params → 200
GET
/properties/land/sale/{id}/{lifeid}
Retrieve a single land property
getLandPropertyAndLife 2 params → 200
ruralProperties 11

Operations related to rural properties

GET
/properties/rural/sale
Retrieve a list of rural properties
getRuralProperties 24 params → 200
POST
/properties/rural/sale
Add a rural property
addRuralProperty body → 201400
GET
/properties/rural/sale/available
Retrieve a list of available rural properties
getAvailableRuralProperties 14 params → 200
GET
/properties/rural/sale/{id}
Retrieve a single rural property
getRuralProperty 1 param → 200
PUT
/properties/rural/sale/{id}
Update a rural property
updateRuralProperty 1 param body → 200400
GET
/properties/rural/sale/sold
Retrieve a list of sold rural properties
getRuralSoldProperties 33 params → 200
GET
/properties/rural/sale/{id}/{lifeid}
Retrieve a single rural property
getRuralPropertyAndLife 2 params → 200
GET
/properties/business/sale/{id}/{lifeid}
Retrieve a single rural property
getBusinessPropertyAndLife 2 params → 200
GET
/properties/livestock/sale/{id}/{lifeid}
Retrieve a single rural property
getLivestockPropertyAndLife 2 params → 200
GET
/properties/clearingSales/sale/{id}/{lifeid}
Retrieve a single rural property
getClearingSalesPropertyAndLife 2 params → 200
GET
/properties/holidayRental/lease/{id}/{lifeid}
Retrieve a single rural property
getHolidayRentalPropertyAndLife 2 params → 200
commercialProperties 13

Operations related to commercial properties

GET
/properties/commercial/sale
Retrieve a list of commercial sale properties
getCommercialSaleProperties 24 params → 200
POST
/properties/commercial/sale
Add a commercial sale property
addCommercialSaleProperty body → 201400
GET
/properties/commercial/sale/available
Retrieve a list of available commercial sale properties
getAvailableCommercialSaleProperties 14 params → 200
GET
/properties/commercial/sale/{id}
Retrieve a single commercial sale property
getCommercialSaleProperty 1 param → 200
PUT
/properties/commercial/sale/{id}
Update a commercial sale property
updateCommercialSaleProperty 1 param body → 200400
GET
/properties/commercial/sale/sold
Retrieve a list of sold commercial properties
getCommercialSoldProperties 30 params → 200
GET
/properties/commercial/lease/leased
Retrieve a list of leased commercial properties
getCommercialLeasedProperties 28 params → 200
GET
/properties/commercial/lease
Retrieve a list of commercial lease properties
getCommercialLeaseProperties 25 params → 200
POST
/properties/commercial/lease
Add a commercial lease property
addCommercialLeaseProperty body → 201400
GET
/properties/commercial/lease/available
Retrieve a list of available commercial lease properties
getAvailableCommercialLeaseProperties 15 params → 200
GET
/properties/commercial/lease/{id}
Retrieve a single commercial lease property
getCommercialLeaseProperty 1 param → 200
PUT
/properties/commercial/lease/{id}
Update a commercial lease property
updateCommercialLeaseProperty 1 param body → 200400
GET
/properties/commercial/sale/{id}/{lifeid}
Retrieve a single commercial property
getCommericalPropertyAndLife 2 params → 200
businessProperties 6

Operations related to business properties

GET
/properties/business/sale
Retrieve a list of business properties
getBusinessProperties 24 params → 200
POST
/properties/business/sale
Add a business property
addBusinessProperty body → 201400
GET
/properties/business/sale/available
Retrieve a list of available business properties
getAvailableBusinessProperties 14 params → 200
GET
/properties/business/sale/{id}
Retrieve a single business property
getBusinessProperty 1 param → 200
PUT
/properties/business/sale/{id}
Update a business property
updateBusinessProperty 1 param body → 200400
GET
/properties/business/sale/sold
Retrieve a list of sold business properties
getBusinessSoldProperties 30 params → 200
holidayRentalProperties 5

Operations related to holiday rental properties

GET
/properties/holidayRental/lease
Retrieve a list of holiday rental properties
getHolidayRentalProperties 25 params → 200
POST
/properties/holidayRental/lease
Add a holiday rental property
addHolidayRentalProperty body → 201400
GET
/properties/holidayRental/lease/available
Retrieve a list of available holiday rental properties
getAvailableHolidayRentalProperties 14 params → 200
GET
/properties/holidayRental/lease/{id}
Retrieve a single holiday rental property
getHolidayRentalProperty 1 param → 200
PUT
/properties/holidayRental/lease/{id}
Update a holiday rental property
updateHolidayRentalProperty 1 param body → 200400
suggest 3

Operations related to suggest services

GET
/suggest/suburb
Search for a suburb
suggestSuburb 7 params → 200
GET
/suggest/district
Search for a district
suggestDistrict 7 params → 200
GET
/suggest/address/corelogic
Search for an address in CoreLogic
suggestAddressCoreLogic 3 params → 200
corelogic 4

Operations related to CoreLogic

GET
/corelogic/properties/{id}
Retrieve a property from CoreLogic
getCoreLogicProperty 1 param → 200
GET
/corelogic/properties/{id}/avm
Retrieve an AVM estimate for this CoreLogic property
getCoreLogicAvm 1 param → 200403
GET
/corelogic/properties/{id}/rentalavm
Retrieve a rental AVM estimate for this CoreLogic property
getCoreLogicRentalAvm 1 param → 200403
GET
/corelogic/disclaimers
Retrieve CoreLogic disclaimers
getCoreLogicDisclaimers → 200
search 7

Operations related to performing searches

GET
/search/properties/address
Search for properties by address
searchProperties 3 params → 200
GET
/search/contacts
Search for contacts by a variety of criteria
searchContacts 16 params → 200
GET
/search/contacts/name
Search for contacts by name
searchContactsName 6 params → 200
GET
/search/contacts/phone
Search for contacts by phone number (exact match)
searchContactsPhone 6 params → 200
GET
/search/contacts/email
Search for contacts by email address (exact match)
searchContactsEmail 6 params → 200
GET
/search/buildings/name
Search for buildings by name
searchBuildingsName 3 params → 200
GET
/search/contactCategories/name
Search for contact categories by name
searchContactCategoriesName 3 params → 200
calendar 5

Operations related to calendar events

GET
/calendar/events
Get a list of calendar events for the user or account
getCalendarEvents 6 params → 200
POST
/calendar/events
Add a calendar event
addCalendarEvent body → 201400
GET
/calendar/events/{id}
Get a single calendar event
getCalendarEvent 1 param → 200
PUT
/calendar/events/{id}
Update a calendar event
updateCalendarEvent 1 param body → 200400
DELETE
/calendar/events/{id}
Delete a calendar event
deleteCalendarEvent 1 param → 204400
tasks 7

Operations related to tasks

GET
/tasks
Get a list of tasks for the account or user
getTasks 10 params → 200
POST
/tasks
Add a task
addTask body → 201400
GET
/tasks/{id}
Get a single task
getTask 1 param → 200
PUT
/tasks/{id}
Update a task
updateTask 1 param body → 200400
DELETE
/tasks/{id}
Delete a task
deleteTask 1 param → 204400
PUT
/tasks/{id}/complete
Mark the task as completed
completeTask 1 param → 200
PUT
/tasks/{id}/uncomplete
Mark the task as incomplete
uncompleteTask 1 param → 200
enquiries 4

Operations related to listing enquiries

GET
/enquiries/{id}
Retrieve a single enquiry from the holding area
getEnquiry 1 param → 200
GET
/enquiries
Get a list of enquiries from the holding area
getEnquiries 11 params → 200
POST
/enquiries
Submit a listing or agent enquiry
addEnquiry body → 201400
GET
/types/holdingArea
Retrieve a list of holding area types
getHoldingAreaTypes 4 params → 200
propertyStats 3

Operations related to property portal stats

PUT
/property/portalStats/cumulative
Update cumulative portal stats for a property
updatePortalStatsCumulative body → 200400
PUT
/property/portalStats/total
Update total portal stats for a property
updatePortalStatsTotal body → 200400
GET
/property/portalStats
Retrieve previously submitted portal stats for a given property and portal
getPortalStats 12 params → 200
templates 12

Operations related to SMS and email templates

GET
/templates/email
Retrieve a list of email templates
getEmailTemplates 2 params → 200
POST
/templates/email
Create an email template
addEmailTemplate body → 201400
GET
/templates/email/{id}
Retrieve a single email template
getEmailTemplate 1 param → 200
PUT
/templates/email/{id}
Update an email template
updateEmailTemplate 1 param body → 200400
GET
/templates/sms
Retrieve a list of SMS templates
getSMSTemplates 2 params → 200
POST
/templates/sms
Create an SMS template
addSMSTemplate body → 201400
GET
/templates/sms/{id}
Retrieve a single SMS template
getSMSTemplate 1 param → 200
PUT
/templates/sms/{id}
Update an SMS template
updateSMSTemplate 1 param body → 200400
GET
/templates/ownerSummary
Retrieve a list of owner summary templates
getOwnerSummaryTemplates 2 params → 200
POST
/templates/ownerSummary
Create an Owner Summary template
addOwnerSummaryTemplate body → 201400
GET
/templates/ownerSummary/{id}
Retrieve a single Owner Summary template
getOwnerSummaryTemplate 1 param → 200
PUT
/templates/ownerSummary/{id}
Update an Owner Summary template
updateOwnerSummaryTemplate 1 param body → 200400
mergeFields 1

Operations related to merge fields for SMS and email templates

GET
/merge-fields
Retrieve available merge fields
getMergeFields 5 params → 200400
maintenance 1

Operations related to maintenance jobs

GET
/maintenance
Retrieve a list of all maintenance jobs for this account
getAllMaintenance 5 params → 200
suppliers 8

Operations related to creditors / suppliers

GET
/suppliers
Retrieve a list of suppliers
getSuppliers 6 params → 200
POST
/suppliers
Create a supplier
addSupplier body → 201400
GET
/suppliers/{id}
Retrieve a single supplier
getSupplier 1 param → 200
PUT
/suppliers/{id}
Update a single supplier
updateSupplier 1 param body → 200400
DELETE
/suppliers/{id}
Delete a supplier
deleteSupplier 1 param → 204400403
GET
/suppliers/{id}/insurance
Retrieve a supplier's insurance
getSupplierInsurance 1 param → 200
PUT
/suppliers/{id}/insurance
Update a single supplier's insurance
updateSupplierInsurance 1 param body → 200400
GET
/suppliers/{id}/categories
Retrieve a list of categories to which this supplier belongs
getCategoriesSupplier 5 params → 200
tenancies 1

Operations related to tenancies

GET
/properties/residential/lease/tenancies
Retrieve a list of residential tenancies
getResidentialLeaseTenancies 2 params → 200
bulk 6

Bulk operations

GET
/bulk/contactNotes/requests
Retrieve a list of previously requested exports of contact notes
retrieveBulkContactNotesExports 5 params → 200
GET
/bulk/contactNotes/request
Retrieve a previously requested export of contact notes
retrieveBulkContactNotesExport 1 param → 200
POST
/bulk/contactNotes/request
Request an export of contact notes
requestBulkContactNotes body → 202400
DELETE
/bulk/contactNotes/request
Delete a previously requested export of contact notes
deleteBulkContactNotesExport 1 param → 204
GET
/bulk/inspections
Retrieve a list of property inspections
getBulkInspections 2 params → 200
GET
/bulk/feedback
Retrieve a list of feedback items
getBulkFeedback 6 params → 200
deals 12

Operations related to commercial deals

GET
/properties/{propertyid}/deals/sale
Retrieve a list of sale deals for this (commercial) property
getPropertySaleDeals 4 params → 200
POST
/properties/{propertyid}/deals/sale
Add a commercial sale deal
addCommercialDealSale 1 param body → 201400
GET
/properties/{propertyid}/deals/lease
Retrieve a list of lease deals for this (commercial) property
getPropertyLeaseDeals 4 params → 200
POST
/properties/{propertyid}/deals/lease
Add a commercial lease deal
addCommercialDealLease 1 param body → 201400
GET
/properties/{propertyid}/deals/sale/{dealid}
Retrieve a commercial sale deal
getCommercialDealSale 2 params → 200
PUT
/properties/{propertyid}/deals/sale/{dealid}
Update a commercial sale deal
updateCommercialDealSale 2 params body → 200400
DELETE
/properties/{propertyid}/deals/sale/{dealid}
Delete a commercial sale deal
deleteCommercialDealSale 2 params → 204400
GET
/properties/{propertyid}/deals/lease/{dealid}
Retrieve a commercial lease deal
getCommercialDealLease 2 params → 200
PUT
/properties/{propertyid}/deals/lease/{dealid}
Update a commercial lease deal
updateCommercialDealLease 2 params body → 200400
DELETE
/properties/{propertyid}/deals/lease/{dealid}
Delete a commercial lease deal
deleteCommercialDealLease 2 params → 204400
GET
/properties/deals/sale
Retrieve a list of commercial sale deals for this account.
getCommercialSaleDeals 7 params → 200
GET
/properties/deals/lease
Retrieve a list of commercial lease deals for this account.
getCommercialLeaseDeals 7 params → 200
suburbs 2

Operations related to suburbs

GET
/suburbs
Retrieve a list of suburbs for the user's country
getSuburbs → 200
GET
/account/customRegions
Retrieve a list of custom regions for this account
getCustomRegions 4 params → 200
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 1 param → 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
advertising 14

Operations related to property and agent advertising

GET
/advertising/invoices
Retrieve a list of advertising invoices
getAdvertisingInvoices 10 params → 200400403
GET
/advertising/invoices/{id}
Retrieve a single advertising invoice
getAdvertisingInvoice 1 param → 200400403
GET
/advertising/schedules
Retrieve a list of advertising schedules
getAdvertisingSchedules 4 params → 200400403
GET
/advertising/schedules/{id}
Retrieve a single advertising schedule
getAdvertisingSchedule 1 param → 200400403
GET
/advertising/suppliers
Retrieve a list of advertising suppliers
getAdvertisingSuppliers 4 params → 200400403
POST
/advertising/suppliers
Add a new advertising supplier
addAdvertisingSupplier body → 201400403
GET
/advertising/suppliers/{id}
Retrieve a single advertising supplier
getAdvertisingSupplier 1 param → 200400403
PUT
/advertising/suppliers/{id}
Update an advertising supplier
updateAdvertisingSupplier 1 param body → 200400403
DELETE
/advertising/suppliers/{id}
Delete an advertising supplier
deleteAdvertisingSupplier 1 param → 204403
GET
/advertising/expenseTypes
Retrieve a list of advertising expense types
getAdvertisingExpenseTypes 5 params → 200400403
GET
/advertising/expenseTypes/{id}
Retrieve a single advertising expense type
getAdvertisingExpenseType 1 param → 200400403
GET
/properties/{propertyid}/sale/{lifeid}/advertising/schedule
Retrieve the attached advertising schedule for this property
getPropertyLifeAdvertisingSchedule 2 params → 200400403
GET
/properties/{propertyid}/sale/{lifeid}/advertising/transactions
Retrieve a list of property advertising transactions
getPropertyLifeAdvertisingTransactions 4 params → 200400403
POST
/advertising/payments
Add an Advertising Payment
addAdvertisingPayment body → 201400
keys 4

Operations related to property keys

GET
/properties/{propertyid}/keys
Retrieve a list of keys for this property
getPropertyKeys 5 params → 200
POST
/properties/{propertyid}/keys
Add a new key to this property
addPropertyKey 1 param body → 201400
GET
/properties/{propertyid}/keys/{id}
Retrieve a key from this property
getPropertyKey 2 params → 200
PUT
/properties/{propertyid}/keys/{id}
Update a property key
updatePropertyKey 2 params body → 200400
lists 2

Operations related to distribution lists

GET
/distributionLists/contact
Retrieve a list of contact distribution lists for this account
getContactDistributionLists 5 params → 200
GET
/distributionLists/contact/{id}
Retrieve a single contact distribution list
getContactDistributionList 1 param → 200
openhomes 1

Operations related to open homes

GET
/openHomes
Retrieve a list of property open homes
getAccountOpenHomes 6 params → 200
precincts 2

Operations related to precincts

GET
/precincts
Retrieve a list of precincts for this account
getAccountPrecincts 4 params → 200
GET
/precincts/{id}
Retrieve a single precinct
getPrecinct 1 param → 200
livestockProperties 5

Operations related to livestock properties

GET
/properties/livestock/sale/sold
Retrieve a list of sold livestock properties
getLivestockSoldProperties 28 params → 200
GET
/properties/livestock/sale
Retrieve a list of livestock properties
getLivestockProperties 24 params → 200
POST
/properties/livestock/sale
Add a livestock property
addLivestockProperty body → 201400
GET
/properties/livestock/sale/{id}
Retrieve a single livestock property
getLivestockProperty 1 param → 200
PUT
/properties/livestock/sale/{id}
Update a livestock property
updateLivestockProperty 1 param body → 200400
clearingSalesProperties 5

Operations related to clearing sales properties

GET
/properties/clearingSales/sale/sold
Retrieve a list of sold clearing sales properties
getClearingSalesSoldProperties 28 params → 200
GET
/properties/clearingSales/sale
Retrieve a list of clearing sales properties
getClearingSalesProperties 24 params → 200
POST
/properties/clearingSales/sale
Add a clearing sales property
addClearingSalesProperty body → 201400
GET
/properties/clearingSales/sale/{id}
Retrieve a single clearing sales property
getClearingSalesProperty 1 param → 200
PUT
/properties/clearingSales/sale/{id}
Update a clearing sales property
updateClearingSalesProperty 1 param body → 200400
fmsleads 2

Operations related to FMS leads

GET
/fms/leads
Get a list of FMS leads
getFMSLeads 2 params → 200
POST
/fms/leads
Submit a new FMS lead
addFMSLead body → 201400
propertyOffer 4

Operations related to property offers

GET
/propertyOffers
Retrieve a list of property offers for this account
getPropertyOffers 8 params → 200
POST
/propertyOffers
Add a property offer
addPropertyOffer body → 201400
GET
/propertyOffers/{id}
Retrieve a single property offer
getPropertyOffer 1 param → 200
PUT
/propertyOffers/{id}
Update a property offer
updatePropertyOffer 1 param body → 200400
campaigns 4

Operations related to marketing campaigns

GET
/campaigns
Retrieve a list of marketing campaigns for this account
getCampaigns 2 params → 200
GET
/campaigns/{id}
Retrieve a single marketing campaign
getCampaign 1 param → 200
GET
/campaigns/{id}/tracking
Retrieve a campaign tracking data
getCampaignTracking 1 param → 200
GET
/campaigns/{id}/tracking/summary
Retrieve campaign stats (totals)
getCampaignTrackingSummary 1 param → 200
conjunctionals 1

Operations related to conjunctional property deals

GET
/conjunctionals
Retrieve a list of conjunctional property deals for this account
getConjunctionals 8 params → 200
invoices 1

Operations related to invoices

GET
/invoices/saleSummary
Retrieve sale summary
getSaleSummary 3 params → 200
reinz 1

Operations related to REINZ

GET
/reinz/sales
Retrieve a list of sales sent to REINZ
getReinzSales 9 params → 200
aml 7

Operations related to AML checks

GET
/aml
Retrieve a list of AML checks
getAMLChecks 5 params → 200
POST
/aml
Create a new AML check for a contact
addAMLCheck body → 201400
GET
/aml/{id}
Retrieve a single AML check
getAMLCheck 1 param → 200
PUT
/aml/{id}
Update an existing AML check
updateAMLCheck 1 param body → 200400
POST
/aml/{id}/notes
Add a new note to the AML check
addAMLNote 1 param body → 201400
DELETE
/aml/{amlid}/files/{id}
Remove an attached file from an AML check
removeAMLNote 2 params → 204
POST
/aml/{id}/files/upload
Attach a file to this AML check
addAMLFile 1 param body → 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 property 1 required
PropertyPhotoOrderResponse
object
3 properties
PropertyPhotoBulkDeleteRequest
object
1 property 1 required
PropertyPhotoBulkDeleteResult
object
4 properties 3 required
PropertyPhotoBulkDeleteResponse
object
4 properties 4 required
MergeContactRequest
object
2 properties
MergeField
object
8 properties 2 required
MergeFieldCategory
object
4 properties 3 required
MergeFieldTier
object
4 properties 3 required
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaultre-api-v1-3-openapi.yml Raw ↑

Other APIs VaultRE publishes across the network.

VaultRE Integrator API
AE Profile APIs.io
VaultRE Aggregator API
AE Profile APIs.io
#Contacts#Properties#Listings#Property Management#Enquiries#AML#Valuation
← Back to V APIs
API Details
ID
vaultre:vaultre-api
Base URL
https://ap-southeast-2.api.vaultre.com.au/api/v1.3
Docs
https://docs.api.vaultre.com.au/swagger/index.html
Provider
VaultRE
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vaultre-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vaultre-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 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.