{ "opencollection": "1.0.0", "info": { "name": "VaultRE", "version": "1.2" }, "items": [ { "info": { "name": "integrator", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of accounts linked to this integrator", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/accounts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of accounts linked to this integrator" }, { "info": { "name": "Retrieve an account linked to this integrator", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the account" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve an account linked to this integrator" }, { "info": { "name": "Retrieve a list of users for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/accounts/:id/users", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the account" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of users for this account" }, { "info": { "name": "Retrieve a user for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/accounts/:accountid/users/:id", "params": [ { "name": "accountid", "value": "", "type": "path", "description": "ID of the account" }, { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a user for this account" }, { "info": { "name": "Retrieve a list of possible scopes for your API key", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/scopes", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of possible scopes for your API key. Note that individual bearer tokens may have fewer scopes applied." }, { "info": { "name": "Retrieve a list of bearer tokens, with accounts, linked to this integrator", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/tokens", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of bearer tokens, with accounts, linked to this integrator" }, { "info": { "name": "Validate a user's credentials", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/integrator/validateUser", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Validate a user's credentials" }, { "info": { "name": "Integrator property statistics", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/externalStats", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add or update a property stat" }, { "info": { "name": "Integrator property statistics", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/externalStats", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the property stats" }, { "info": { "name": "Retrieve a list of granted scopes for this bearer token", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/scopes", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of granted scopes for this bearer token" } ] }, { "info": { "name": "types", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of response codes used in this API", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/responseCodes", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of response codes used in this API" }, { "info": { "name": "Retrieve a list of property classes", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/propertyClass", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property classes" }, { "info": { "name": "Retrieve a list of property types", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/propertyType", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property types applicable to this account" }, { "info": { "name": "Retrieve a list of contact interest types", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/contactInterest", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact interest types" }, { "info": { "name": "Retrieve a list of contact entity types", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/entityTypes", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact entity types" }, { "info": { "name": "Retrieve a list of property external link types", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/externalLinks", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property external link types" }, { "info": { "name": "Retrieve a list of contact note types for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/contactnotes", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact note types for this account" }, { "info": { "name": "Retrieve a single contact note type", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/contactnotes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the note type" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact note type" }, { "info": { "name": "Retrieve a list of property note types for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/propertynotes", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property note types for this account" }, { "info": { "name": "Retrieve a single property note type", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/propertynotes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the note type" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single property note type" }, { "info": { "name": "Retrieve a list of price qualifier types", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/types/priceQualifiers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of price qualifier types. This field is only available for NZ and UK accounts." } ] }, { "info": { "name": "buildings", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of buildings", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/buildings", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of buildings" }, { "info": { "name": "Create a building record", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/buildings", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a building record" }, { "info": { "name": "Retrieve a single building", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/buildings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the building" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single building" }, { "info": { "name": "Update the building", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/buildings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the building" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the building" }, { "info": { "name": "Delete the building", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/buildings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the building" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete the building" } ] }, { "info": { "name": "categories", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of contact category groups", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/groups", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact category groups" }, { "info": { "name": "Retrieve a single contact category group", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the category group" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact category group" }, { "info": { "name": "Retrieve a list of categories in this contact category group", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/groups/:id/categories", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the category group" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of categories in this contact category group" }, { "info": { "name": "Create a contact category in this grouping", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/groups/:id/categories", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a contact category in this grouping" }, { "info": { "name": "Retrieve a single category in this contact category group", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/groups/:groupingid/categories/:id", "params": [ { "name": "groupingid", "value": "", "type": "path", "description": "ID of the category group" }, { "name": "id", "value": "", "type": "path", "description": "ID of the category" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single category in this contact category group" }, { "info": { "name": "Update a contact category in this grouping", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/groups/:groupingid/categories/:id", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a contact category in this grouping" }, { "info": { "name": "Retrieve a list of contact categories", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact categories" }, { "info": { "name": "Retrieve a single contact category", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/contact/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the category" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact category" }, { "info": { "name": "Retrieve a list of property category groups", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/property/groups", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property category groups" }, { "info": { "name": "Retrieve a single property category group", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/property/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the category group" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single property category group" }, { "info": { "name": "Retrieve a list of property categories", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/property", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property categories" }, { "info": { "name": "Retrieve a single property category", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/categories/property/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the category" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single property category" } ] }, { "info": { "name": "contacts", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of contacts", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "categories", "value": "", "type": "query", "description": "Filter contacts belonging to category IDs" }, { "name": "entityType", "value": "", "type": "query", "description": "Filter contacts by entity type" }, { "name": "archived", "value": "", "type": "query", "description": "Filter contacts by archived status" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "marketingUser", "value": "", "type": "query", "description": "Filter by marketing user(s)" }, { "name": "marketingUserPosition", "value": "", "type": "query", "description": "Used in conjuction with marketingUser, filter by marketing user position ID" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contacts" }, { "info": { "name": "Create a contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a contact" }, { "info": { "name": "Retrieve a single contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact" }, { "info": { "name": "Update a single contact", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a single contact" }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a contact" }, { "info": { "name": "Send an SMS to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/sms", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Send an SMS to this contact from the authenticated user or selected user (charges may apply)." }, { "info": { "name": "Send multiple SMS messages to contacts", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/sms", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Send multiple SMS messages to these contacts from the authenticated user or selected user (charges may apply). Maximum 50 recipients in any one request." }, { "info": { "name": "Send an email to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/email", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Send an email to this contact from the authenticated user or selected user (if provided)." }, { "info": { "name": "Send multiple emails to contacts", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/email", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Send multiple emails to these contacts from the authenticated user or selected user (if provided). Maximum 50 recipients in any one request." }, { "info": { "name": "Retrieve contextual information about this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/context", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve contextual information about this contact" }, { "info": { "name": "Retrieve a list of recently accessed contacts", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/recentlyAccessed", "params": [ { "name": "archived", "value": "", "type": "query", "description": "Filter contacts by archived status" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of recently accessed contacts" }, { "info": { "name": "Retrieve a list of notes attached to this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/notes", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "types", "value": "", "type": "query", "description": "Filter notes with type IDs" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of notes attached to this contact" }, { "info": { "name": "Add a note to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/notes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a note to this contact" }, { "info": { "name": "Add multiple contact notes", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/notes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add multiple contact notes in a batch. Maximum 100 notes in any one request." }, { "info": { "name": "Retrieve a single contact note", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/notes/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the note" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact note" }, { "info": { "name": "Update a contact note", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/notes/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the note" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a contact note" }, { "info": { "name": "Delete a contact note", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/notes/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the note" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a contact note" }, { "info": { "name": "Retrieve a list of categories to which this contact belongs", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/categories", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of categories to which this contact belongs" }, { "info": { "name": "Attach one or more categories to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/categories", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach one or more categories to this contact" }, { "info": { "name": "Update the categories to which this contact belongs", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/categories", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the categories to which this contact belongs" }, { "info": { "name": "Remove categories from this contact", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/categories/remove", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Remove categories from this contact" }, { "info": { "name": "Retrieve a list of custom fields for this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/custom", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of custom fields for this contact" }, { "info": { "name": "Update the custom fields for this contact", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/custom", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the custom fields for this contact" }, { "info": { "name": "Retrieve a list of files attached to this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of files attached to this contact" }, { "info": { "name": "Attach a file to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a file to this contact. This endpoint is suitable for smaller files (<5MB). For larger files use POST /contacts/{id}/files/upload" }, { "info": { "name": "Attach a file to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/files/upload", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a file to this contact. This endpoint returns an upload_url where the file data can be PUT. Can be used for large files." }, { "info": { "name": "Retrieve a single file attached to this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/files/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the file" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single file attached to this contact" }, { "info": { "name": "Delete a file attached to this contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/files/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the file" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a file attached to this contact" }, { "info": { "name": "Retrieve a list of calendar events attached to this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/events", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of calendar events attached to this contact" }, { "info": { "name": "Mark the contact record as touched", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/touch", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Mark the contact record as touched" }, { "info": { "name": "Retrieve a list of buying/renting requirements for this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/requirements", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "active", "value": "", "type": "query", "description": "Filter active/inactive requirements" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of buying/renting requirements for this contact" }, { "info": { "name": "Add a requirement for this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/requirements", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a requirement for this contact" }, { "info": { "name": "Retrieve a single buying/renting requirement for this contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/requirements/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the requirement" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single buying/renting requirement for this contact" }, { "info": { "name": "Update a requirement for this contact", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/requirements/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the requirement" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a requirement for this contact" }, { "info": { "name": "Delete a buying/renting requirement for the contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:contactid/requirements/:id", "params": [ { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "id", "value": "", "type": "path", "description": "ID of the requirement" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a buying/renting requirement for the contact" }, { "info": { "name": "Retrieve a list of buying/renting requirements across all contacts", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/requirements", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "active", "value": "", "type": "query", "description": "Filter active/inactive requirements" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of buying/renting requirements across all contacts" }, { "info": { "name": "Retrieve a list of contact marketing users across all contacts", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/marketingUsers", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact marketing users across all contacts" }, { "info": { "name": "Retrieve a list of current tenants across all properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/currentTenants", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of current tenants across all properties" }, { "info": { "name": "Retrieve a list of current landlords across all properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/currentLandlords", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of current landlords across all properties" }, { "info": { "name": "Retrieve a list of current owners/vendors across all sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/currentOwners", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of current owners/vendors across all sale properties" }, { "info": { "name": "Retrieve a list of current purchasers across all sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/currentPurchasers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of current purchasers across all sale properties" }, { "info": { "name": "Retrieve a list of contact category mappings across all contacts", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/categories", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact category mappings across all contacts" }, { "info": { "name": "Allow a user to access this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/access", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Allow a user to access this contact" }, { "info": { "name": "Retrieve the activity log for a contact", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/contacts/:id/activityLog", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contact" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve the activity log for a contact" } ] }, { "info": { "name": "user", "type": "folder" }, "items": [ { "info": { "name": "Retrieve information about the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve information about the authenticated user" }, { "info": { "name": "Update the authenticated user", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the authenticated user" }, { "info": { "name": "Retrieve active subscriptions for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/subscriptions", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve active subscriptions for the authenticated user" }, { "info": { "name": "Retrieve a list of teams to which the authenticated user belongs", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/teams", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of teams to which the authenticated user belongs" }, { "info": { "name": "Retrieve a summary of recent gross commission for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/summary/grossCommission", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a month by month summary of recent gross commission (previous six months) for the authenticated user" }, { "info": { "name": "Retrieve a list of upcoming offer conditions for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/upcomingOfferConditions", "params": [ { "name": "days", "value": "", "type": "query", "description": "Number of days to look ahead and back (default 8)" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of upcoming offer conditions for the authenticated user" }, { "info": { "name": "Retrieve a list of upcoming open homes for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/upcomingOpenHomes", "params": [ { "name": "days", "value": "", "type": "query", "description": "Number of days to look ahead and back (default 7)" }, { "name": "includeRecent", "value": "", "type": "query", "description": "Include recently completed open homes" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of upcoming open homes for the authenticated user" }, { "info": { "name": "Retrieve a list of upcoming and recent inspections for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/tenancyInspections", "params": [ { "name": "days", "value": "", "type": "query", "description": "Number of days to look ahead and back (default 7). Only used if start and end are undefined." }, { "name": "includeRecent", "value": "", "type": "query", "description": "Include recently completed inspections. Used in conjuction with days argument." }, { "name": "start", "value": "", "type": "query", "description": "Filter inspections starting on or after this datetime. Takes precendent over days argument." }, { "name": "end", "value": "", "type": "query", "description": "Filter inspections starting before this datetime. Takes precendent over days argument." }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of upcoming and recent inspections for the authenticated user" }, { "info": { "name": "Update the credentials for the authenticated user", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the credentials for the authenticated user" }, { "info": { "name": "Retrieve the authenticated user's signature", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/signature", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve the authenticated user's signature" }, { "info": { "name": "Update the signature for the authenticated user", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/signature", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the signature for the authenticated user" }, { "info": { "name": "Retrieve the authenticated user's photograph", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/photo", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve the authenticated user's photograph" }, { "info": { "name": "Update the photo for the authenticated user", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/user/photo", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the photo for the authenticated user" }, { "info": { "name": "Retrieve information about the authenticated account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve information about the authenticated account" }, { "info": { "name": "Retrieve a list of users in the authenticated account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/users", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "team", "value": "", "type": "query", "description": "Filter users belonging to the given team ID" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of users in the authenticated account" }, { "info": { "name": "Retrieve a single user from the account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single user from the account" }, { "info": { "name": "Retrieve a list of teams to which this user belongs", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/users/:id/teams", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of teams to which this user belongs" }, { "info": { "name": "Retrieve a list of teams in the authenticated account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/teams", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of teams in the authenticated account" }, { "info": { "name": "Retrieve a single team from the account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/teams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the team" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single team from the account" }, { "info": { "name": "Retrieve a list of enquiry sources in the authenticated account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/enquirySources", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of enquiry sources in the authenticated account" }, { "info": { "name": "Add a new Enquiry Source type", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/enquirySources", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a new Enquiry Source type" }, { "info": { "name": "Retrieve a single enquiry source", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/enquirySources/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the enquiry source" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single enquiry source" }, { "info": { "name": "Update an Enquiry Source type", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/enquirySources/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the enquiry source" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an Enquiry Source type" }, { "info": { "name": "Retrieve pricing information for the authenticated account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/pricing", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve pricing information for the authenticated account" }, { "info": { "name": "Retrieve a list of upcoming open homes for the authenticated account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/upcomingOpenHomes", "params": [ { "name": "days", "value": "", "type": "query", "description": "Number of days to look ahead and back (default 7)" }, { "name": "includeRecent", "value": "", "type": "query", "description": "Include recently completed open homes" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of upcoming open homes for the authenticated account" }, { "info": { "name": "Retrieve a list of folders available in the Filing Cabinet for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/folders/filingCabinet", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of folders available in the Filing Cabinet for this account" }, { "info": { "name": "Retrieve a list of branches configured for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/branches", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of branches configured for this account" }, { "info": { "name": "Retrieve a list of property portals for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/propertyPortals", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property portals to which this account can publish properties" }, { "info": { "name": "Retrieve a list of trust accounts for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/account/trustAccounts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of trust accounts for this account" }, { "info": { "name": "Log out from the current user session", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/logout", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Log out from the current user session" }, { "info": { "name": "Verify the authenticated user's password", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/verifyPassword", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Verify the authenticated user's password" }, { "info": { "name": "Generate a single-sign-on URL", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/sso", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Generate a single-sign-on URL for the VaultRE web application" } ] }, { "info": { "name": "properties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties", "params": [ { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of properties" }, { "info": { "name": "Retrieve a single property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single property" }, { "info": { "name": "Delete a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a property" }, { "info": { "name": "Retrieve a list of sale or lease properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:salelease", "params": [ { "name": "salelease", "value": "", "type": "path", "description": "sale/lease" }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "types", "value": "", "type": "query", "description": "Filter properties in these type IDs" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "propertyClass", "value": "", "type": "query", "description": "Filter by a list of property classes" }, { "name": "availableOnly", "value": "", "type": "query", "description": "Only used to if propertyClass equals 'commercial'" }, { "name": "tenantedInvestmentOnly", "value": "", "type": "query", "description": "Only used to if propertyClass equals 'commercial'" }, { "name": "minBed", "value": "", "type": "query", "description": "Filter properties greater than or equal to min beds" }, { "name": "minBath", "value": "", "type": "query", "description": "Filter properties greater than or equal to min baths" }, { "name": "minCar", "value": "", "type": "query", "description": "Filter properties greater than or equal to min car spaces" }, { "name": "minPricePerSqm", "value": "", "type": "query", "description": "Filter properties greater than or equal to min price per sqm" }, { "name": "maxPricePerSqm", "value": "", "type": "query", "description": "Filter properties less than or equal to max price per sqm" }, { "name": "minPrice", "value": "", "type": "query", "description": "Filter properties greater than or equal to min price" }, { "name": "maxPrice", "value": "", "type": "query", "description": "Filter properties less than or equal to max price" }, { "name": "minLand", "value": "", "type": "query", "description": "Filter properties greater than or equal to min land. Must supply an area type." }, { "name": "maxLand", "value": "", "type": "query", "description": "Filter properties less than or equal to max land. Must supply an area type." }, { "name": "areaType", "value": "", "type": "query", "description": "Specify the units for minLand, maxLand filters" }, { "name": "minFloor", "value": "", "type": "query", "description": "Filter properties greater than or equal to min floor." }, { "name": "maxFloor", "value": "", "type": "query", "description": "Filter properties less than or equal to max floor." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sale or lease properties" }, { "info": { "name": "Retrieve a list of notes attached to this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/notes", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "types", "value": "", "type": "query", "description": "Filter notes with type IDs" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of notes attached to this property" }, { "info": { "name": "Add a note to this property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/notes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a note to this property" }, { "info": { "name": "Retrieve a single property note", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/notes/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "id", "value": "", "type": "path", "description": "ID of the note" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single property note" }, { "info": { "name": "Update a property note", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/notes/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "id", "value": "", "type": "path", "description": "ID of the note" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a property note" }, { "info": { "name": "Delete a property note", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/notes/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "id", "value": "", "type": "path", "description": "ID of the note" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a property note" }, { "info": { "name": "Retrieve a list of photos for this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/photos", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of photos for this property" }, { "info": { "name": "Upload a new photo to this property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/photos", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "multipart-form", "data": [ { "name": "photo", "type": "text", "value": "" }, { "name": "caption", "type": "text", "value": "" }, { "name": "published", "type": "text", "value": "" }, { "name": "type", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Upload a new photo to this property. This endpoint is suitable for smaller files (<5MB). For larger files use POST /properties/{id}/photos/upload" }, { "info": { "name": "Upload a new photo to this property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/photos/upload", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Upload a new photo to this property. This endpoint returns an upload_url where the file data can be PUT. Can be used for large files." }, { "info": { "name": "Retrieve a single photo for this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/photos/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "id", "value": "", "type": "path", "description": "ID of the photo" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single photo for this property" }, { "info": { "name": "Delete a photo attached to this property", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/photos/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "id", "value": "", "type": "path", "description": "ID of the photo" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a photo attached to this property" }, { "info": { "name": "Retrieve a list of tags for this property photo", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/photos/:id/tags", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "id", "value": "", "type": "path", "description": "ID of the photo" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "minimumConfidence", "value": "", "type": "query", "description": "Only return tags with a confidence greater than or equal to this number" }, { "name": "maximumConfidence", "value": "", "type": "query", "description": "Only return tags with a confidence less than or equal to this number" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of tags for this property photo, derived from Machine Learning analysis of property photos" }, { "info": { "name": "Retrieve a list of tags for this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "minimumConfidence", "value": "", "type": "query", "description": "Only return tags with a confidence greater than or equal to this number" }, { "name": "maximumConfidence", "value": "", "type": "query", "description": "Only return tags with a confidence less than or equal to this number" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of tags for this property, derived from Machine Learning analysis of property photos" }, { "info": { "name": "Retrieve a list of categories to which this property belongs", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/categories", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of categories to which this property belongs" }, { "info": { "name": "Retrieve the activity log for a property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/activityLog", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve the activity log for a property" }, { "info": { "name": "Retrieve a list of files attached to this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of files attached to this property" }, { "info": { "name": "Retrieve a list of contacts with requirements matching this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/matchingContacts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contacts with requirements matching this property" }, { "info": { "name": "Retrieve a list of files attached to this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of files attached to this property life" }, { "info": { "name": "Attach a file to this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" } ], "body": { "type": "multipart-form", "data": [ { "name": "folders", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a file to this property life. This endpoint is suitable for smaller files (<5MB). For larger files use POST /properties/{id}/{salelease}/{lifeid}/files/upload" }, { "info": { "name": "Attach a file to this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/files/upload", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a file to this property life. This endpoint returns an upload_url where the file data can be PUT. Can be used for large files." }, { "info": { "name": "Retrieve a single file attached to this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/files/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "id", "value": "", "type": "path", "description": "ID of the file" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single file attached to this property life" }, { "info": { "name": "Delete a single file attached to this property life", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/files/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "id", "value": "", "type": "path", "description": "ID of the file" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a single file attached to this property life" }, { "info": { "name": "Retrieve a list of property feedback attached to this life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/feedback", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "feedbackAfter", "value": "", "type": "query", "description": "Filter feedback occurring on or after this date" }, { "name": "feedbackBefore", "value": "", "type": "query", "description": "Filter feedback occurring before this date" }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "contacts", "value": "", "type": "query", "description": "Filter feedback from certain contacts" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property feedback attached to this life" }, { "info": { "name": "Attach feedback to this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/feedback", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach feedback to this property life" }, { "info": { "name": "Retrieve a property feedback item attached to this life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/feedback/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the feedback" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a property feedback item attached to this life" }, { "info": { "name": "Update a feedback item", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/feedback/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the feedback" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a feedback item" }, { "info": { "name": "Delete a property feedback item", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/feedback/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the feedback" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a property feedback item" }, { "info": { "name": "Retrieve a summary of property feedback feedback attached to this life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/feedback/summary", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "feedbackAfter", "value": "", "type": "query", "description": "Filter feedback occurring on or after this date" }, { "name": "feedbackBefore", "value": "", "type": "query", "description": "Filter feedback occurring before this date" }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a summary showing how many times each contact has provided feedback/interacted with this property life" }, { "info": { "name": "Retrieve a list of open homes attached to this life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/openHomes", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "startingAfter", "value": "", "type": "query", "description": "Filter open homes occurring on or after this date" }, { "name": "startingBefore", "value": "", "type": "query", "description": "Filter open homes occurring before this date" }, { "name": "userid", "value": "", "type": "path", "description": "Filter open homes attached to this user" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of open homes attached to this life" }, { "info": { "name": "Create a new open home for this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/openHomes", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a new open home for this property life" }, { "info": { "name": "Retrieve a single open home attached to this life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/openHomes/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the open home" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single open home attached to this life" }, { "info": { "name": "Update an open home for this property life", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/openHomes/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the open home" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an open home for this property life" }, { "info": { "name": "Delete an open home", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/openHomes/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the open home" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete an open home" }, { "info": { "name": "Retrieve a list of owners attached to this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/owners", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of owners attached to this property life" }, { "info": { "name": "Attach an owner to this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/owners", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach an owner to this property life" }, { "info": { "name": "Update owners for this property life", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/owners", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update owners for this property life" }, { "info": { "name": "Remove a landlord from this property life", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/landlords/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the landlord" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Remove a landlord from this property life" }, { "info": { "name": "Remove a tenant from this property life", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/tenancy/:tenancyid/tenants/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" }, { "name": "id", "value": "", "type": "path", "description": "ID of the tenant" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Remove a tenant from this property life" }, { "info": { "name": "Remove an owner from this property life", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/sale/:lifeid/owners/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the owner" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Remove an owner from this property life" }, { "info": { "name": "Remove a purchaser from this property life", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/sale/:lifeid/purchasers/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the purchaser" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Remove a purchaser from this property life" }, { "info": { "name": "Retrieve a list of landlords attached to this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/:lifeid/landlords", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of landlords attached to this property life" }, { "info": { "name": "Attach a landlord to this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/:lifeid/landlords", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a landlord to this property life" }, { "info": { "name": "Update landlords for this property life", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/:lifeid/landlords", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update landlords for this property life" }, { "info": { "name": "Retrieve a list of purchasers attached to this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/purchasers", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of purchasers attached to this property life" }, { "info": { "name": "Attach a purchaser to this property life", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/purchasers", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a purchaser to this property life" }, { "info": { "name": "Update purchasers for this property life", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/purchasers", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update purchasers for this property life" }, { "info": { "name": "Retrieve a list of tenants attached to this tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/:lifeid/tenancy/:tenancyid/tenants", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of tenants attached to this tenancy" }, { "info": { "name": "Attach a tenant to this tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/:lifeid/tenancy/:tenancyid/tenants", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Attach a tenant to this tenancy" }, { "info": { "name": "Update tenants for this tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/:lifeid/tenancy/:tenancyid/tenants", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update tenants for this tenancy" }, { "info": { "name": "Retrieve features for this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/features", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve features for this property" }, { "info": { "name": "Update features for this property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/features", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update features for this property" }, { "info": { "name": "Retrieve a list of custom fields for a given property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:class/:salelease/:id/custom", "params": [ { "name": "class", "value": "", "type": "path", "description": "Class of property" }, { "name": "salelease", "value": "", "type": "path", "description": "Filter by sale or lease properties" }, { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of custom fields for a given property" }, { "info": { "name": "Update the custom fields for this property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:class/:salelease/:id/custom", "params": [ { "name": "class", "value": "", "type": "path", "description": "Class of property" }, { "name": "salelease", "value": "", "type": "path", "description": "Filter by sale or lease properties" }, { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update the custom fields for this property" }, { "info": { "name": "Retrieve a list of offer conditions for this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/:lifeid/offerConditions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "userid", "value": "", "type": "query", "description": "Items related to this user ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Sort items by field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of offer conditions for this property life" }, { "info": { "name": "Retrieve an offer condition for this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/sale/:lifeid/offerConditions/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the offer condition" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve an offer condition for this property life" }, { "info": { "name": "Update a property's offer condition", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/sale/:lifeid/offerConditions/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the offer condition" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a property's offer condition" }, { "info": { "name": "Complete a property's offer condition", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/sale/:lifeid/offerConditions/:id/complete", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the offer condition" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Complete a property's offer condition" }, { "info": { "name": "Uncomplete a property's offer condition", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/sale/:lifeid/offerConditions/:id/uncomplete", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the offer condition" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Uncomplete a property's offer condition" }, { "info": { "name": "Retrieve a list of upcoming open homes", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:class/:salelease/upcomingOpenHomes", "params": [ { "name": "class", "value": "", "type": "path", "description": "Class of property" }, { "name": "salelease", "value": "", "type": "path", "description": "Filter by sale or lease properties" }, { "name": "days", "value": "", "type": "query", "description": "Number of days to look ahead (default 7)" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of upcoming open homes" }, { "info": { "name": "Look up property information based on property reference", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/lookup/:propertyReference", "params": [ { "name": "propertyReference", "value": "", "type": "path", "description": "Property reference to look up" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Look up property information based on the property reference sent to portal sites (e.g. <uniqueID>)" }, { "info": { "name": "Convert a prospect or appraisal sale property to listing status", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/sale/statusChange/listing", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Convert a prospect or appraisal sale property to listing status" }, { "info": { "name": "Convert a prospect or appraisal lease property to management status", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/lease/statusChange/management", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Convert a prospect or appraisal lease property to management status" }, { "info": { "name": "Retrieve a list of contacts and their interest related this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/interest", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contacts and their interest related this property life" }, { "info": { "name": "Retrieve a single contact's interest in this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/interest/:contactid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact's interest in this property life" }, { "info": { "name": "Update a contact's interest in this property life", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/interest/:contactid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a contact's interest in this property life" }, { "info": { "name": "Retrieve a list of contacts and their source of enquiry related this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/enquirySources", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contacts and their source of enquiry related this property life" }, { "info": { "name": "Retrieve a single contact's source of enquiry for this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/enquirySources/:contactid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single contact's source of enquiry for this property life" }, { "info": { "name": "Update a contact's source of enquiry for this property life", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:id/:salelease/:lifeid/enquirySources/:contactid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease life record" }, { "name": "contactid", "value": "", "type": "path", "description": "ID of the contact" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a contact's source of enquiry for this property life" }, { "info": { "name": "Retrieve a list of maintenance jobs for this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "tenancy", "value": "", "type": "query", "description": "Filter maintenance jobs for this tenancy id" }, { "name": "completed", "value": "", "type": "query", "description": "Filter maintenance jobs by their completed status" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of maintenance jobs for this property life" }, { "info": { "name": "Create a maintenance job", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a maintenance job" }, { "info": { "name": "Retrieve a single maintenance job", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single maintenance job" }, { "info": { "name": "Update a single maintenance job", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a single maintenance job" }, { "info": { "name": "Delete a maintenance job", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a maintenance job" }, { "info": { "name": "Add a maintenance job photo", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/photos", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" } ], "body": { "type": "multipart-form", "data": [ { "name": "description", "type": "text", "value": "" }, { "name": "photo", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a maintenance job photo" }, { "info": { "name": "Retrieve a single maintenance job photo", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/photos/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" }, { "name": "id", "value": "", "type": "path", "description": "ID of the maintenance job photo" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single maintenance job photo" }, { "info": { "name": "Delete a maintenance job photo", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/photos/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" }, { "name": "id", "value": "", "type": "path", "description": "ID of the maintenance job photo" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a maintenance job photo" }, { "info": { "name": "Retrieve a list of requests for a maintenance job", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/requests", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "workOrders", "value": "", "type": "query", "description": "Filter maintenance job requests by work order status" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of requests for a maintenance job" }, { "info": { "name": "Create a maintenance job request", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/requests", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a maintenance request" }, { "info": { "name": "Initiate a maintenance work order", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/requests/:id/initiateWorkOrder", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" }, { "name": "id", "value": "", "type": "path", "description": "ID of the maintenance request" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Initiate a maintenance work order" }, { "info": { "name": "Complete a maintenance work order", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/requests/:id/complete", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" }, { "name": "id", "value": "", "type": "path", "description": "ID of the maintenance request" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Complete a maintenance work order" }, { "info": { "name": "Retrieve a list of notes for a maintenance job", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/maintenance/:jobid/notes", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "jobid", "value": "", "type": "path", "description": "ID of the maintenance job" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of notes for a maintenance job" }, { "info": { "name": "Retrieve a list of inspections for a tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/tenancy/:id/inspections", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the tenancy" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "completed", "value": "", "type": "query", "description": "Filter inspections by their completed status" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of inspections for a tenancy" }, { "info": { "name": "Create an inspection", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/tenancy/:id/inspections", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "id", "value": "", "type": "path", "description": "ID of the tenancy" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create an inspection" }, { "info": { "name": "Retrieve a single inspection for a tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/tenancy/:tenancyid/inspections/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" }, { "name": "id", "value": "", "type": "path", "description": "ID of the inspection" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single inspection for a tenancy" }, { "info": { "name": "Update an inspection", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/tenancy/:tenancyid/inspections/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" }, { "name": "id", "value": "", "type": "path", "description": "ID of the inspection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an inspection" }, { "info": { "name": "Delete an inspection", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/lease/:lifeid/tenancy/:tenancyid/inspections/:id", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the lease life" }, { "name": "tenancyid", "value": "", "type": "path", "description": "ID of the tenancy" }, { "name": "id", "value": "", "type": "path", "description": "ID of the inspection" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete an inspection" }, { "info": { "name": "Trigger a property to be re-sent to certain portal sites", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/property/flush", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Trigger a property to be re-sent to certain portal sites. Note that this endpoint only sends properties that are already selected to feed to the given sites. Please contact VaultRE for valid values of 'portals'" }, { "info": { "name": "Retrieve the full sale history for a property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/saleHistory", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve the full sale history for a property including commission splits" }, { "info": { "name": "Add a Scheduled Viewing", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/:salelease/:lifeid/scheduledViewing", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "salelease", "value": "", "type": "path", "description": "Sale or lease" }, { "name": "lifeid", "value": "", "type": "path", "description": "ID of the property life" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a Scheduled Viewing" }, { "info": { "name": "Retrieve a list of property category mappings across all properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/categories", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property category mappings across all properties" } ] }, { "info": { "name": "residentialProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of residential sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/sale", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of residential sale properties" }, { "info": { "name": "Add a residential sale property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/sale", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a residential sale property" }, { "info": { "name": "Retrieve a list of available residential sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/sale/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available residential sale properties. This is the same as the /properties/residential/sale endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single residential sale property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single residential sale property" }, { "info": { "name": "Update a residential sale property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a residential sale property" }, { "info": { "name": "Retrieve a list of sold residential sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/sale/sold", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "unconditionalSince", "value": "", "type": "query", "description": "Filter results with unconditional date since this date" }, { "name": "unconditionalBefore", "value": "", "type": "query", "description": "Filter results with unconditional date before this date" }, { "name": "settlementSince", "value": "", "type": "query", "description": "Filter results with settlement date since this date" }, { "name": "settlementBefore", "value": "", "type": "query", "description": "Filter results with settlement date before this date" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sold residential sale properties" }, { "info": { "name": "Retrieve a list of residential lease properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/lease", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "leasedSince", "value": "", "type": "query", "description": "Filter results leased since this datetime" }, { "name": "leasedBefore", "value": "", "type": "query", "description": "Filter results leased before this datetime" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "availableOnly", "value": "", "type": "query", "description": "Filter available lease properties only" }, { "name": "leasedOnly", "value": "", "type": "query", "description": "Filter leased properties only" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of residential lease properties" }, { "info": { "name": "Add a residential lease property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/lease", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a residential lease property" }, { "info": { "name": "Retrieve a list of available residential lease properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/lease/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available residential lease properties. This is the same as the /properties/residential/lease endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single residential lease property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/lease/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single residential lease property" }, { "info": { "name": "Update a residential lease property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/lease/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a residential lease property" } ] }, { "info": { "name": "landProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of land properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/land/sale", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of land properties" }, { "info": { "name": "Add a land property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/land/sale", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a land property" }, { "info": { "name": "Retrieve a list of available land properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/land/sale/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available land properties. This is the same as the /properties/land/sale endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single land property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/land/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single land property" }, { "info": { "name": "Update a land property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/land/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a land property" }, { "info": { "name": "Retrieve a list of sold land properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/land/sale/sold", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "unconditionalSince", "value": "", "type": "query", "description": "Filter results with unconditional date since this date" }, { "name": "unconditionalBefore", "value": "", "type": "query", "description": "Filter results with unconditional date before this date" }, { "name": "settlementSince", "value": "", "type": "query", "description": "Filter results with settlement date since this date" }, { "name": "settlementBefore", "value": "", "type": "query", "description": "Filter results with settlement date before this date" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sold land properties" } ] }, { "info": { "name": "ruralProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of rural properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/rural/sale", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of rural properties" }, { "info": { "name": "Add a rural property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/rural/sale", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a rural property" }, { "info": { "name": "Retrieve a list of available rural properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/rural/sale/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available rural properties. This is the same as the /properties/rural/sale endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single rural property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/rural/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single rural property" }, { "info": { "name": "Update a rural property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/rural/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a rural property" }, { "info": { "name": "Retrieve a list of sold rural properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/rural/sale/sold", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "unconditionalSince", "value": "", "type": "query", "description": "Filter results with unconditional date since this date" }, { "name": "unconditionalBefore", "value": "", "type": "query", "description": "Filter results with unconditional date before this date" }, { "name": "settlementSince", "value": "", "type": "query", "description": "Filter results with settlement date since this date" }, { "name": "settlementBefore", "value": "", "type": "query", "description": "Filter results with settlement date before this date" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sold rural properties" } ] }, { "info": { "name": "commercialProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of commercial sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/sale", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of commercial sale properties" }, { "info": { "name": "Add a commercial sale property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/sale", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a commercial sale property" }, { "info": { "name": "Retrieve a list of available commercial sale properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/sale/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available commercial sale properties. This is the same as the /properties/commercial/sale endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single commercial sale property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single commercial sale property" }, { "info": { "name": "Update a commercial sale property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a commercial sale property" }, { "info": { "name": "Retrieve a list of sold commercial properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/sale/sold", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "unconditionalSince", "value": "", "type": "query", "description": "Filter results with unconditional date since this date" }, { "name": "unconditionalBefore", "value": "", "type": "query", "description": "Filter results with unconditional date before this date" }, { "name": "settlementSince", "value": "", "type": "query", "description": "Filter results with settlement date since this date" }, { "name": "settlementBefore", "value": "", "type": "query", "description": "Filter results with settlement date before this date" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sold commercial properties" }, { "info": { "name": "Retrieve a list of leased commercial properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/lease/leased", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "unconditionalSince", "value": "", "type": "query", "description": "Filter results with unconditional date since this date" }, { "name": "unconditionalBefore", "value": "", "type": "query", "description": "Filter results with unconditional date before this date" }, { "name": "settlementSince", "value": "", "type": "query", "description": "Filter results with settlement date since this date" }, { "name": "settlementBefore", "value": "", "type": "query", "description": "Filter results with settlement date before this date" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of leased commercial properties" }, { "info": { "name": "Retrieve a list of commercial lease properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/lease", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "availableOnly", "value": "", "type": "query", "description": "Filter available lease properties only" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of commercial lease properties" }, { "info": { "name": "Add a commercial lease property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/lease", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a commercial lease property" }, { "info": { "name": "Retrieve a list of available commercial lease properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/lease/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "availableOnly", "value": "", "type": "query", "description": "Filter available lease properties only" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available commercial lease properties. This is the same as the /properties/commercial/lease endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single commercial lease property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/lease/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single commercial lease property" }, { "info": { "name": "Update a commercial lease property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/commercial/lease/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a commercial lease property" } ] }, { "info": { "name": "businessProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of business properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/business/sale", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of business properties" }, { "info": { "name": "Add a business property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/business/sale", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a business property" }, { "info": { "name": "Retrieve a list of available business properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/business/sale/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available business properties. This is the same as the /properties/business/sale endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single business property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/business/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single business property" }, { "info": { "name": "Update a business property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/business/sale/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a business property" }, { "info": { "name": "Retrieve a list of sold business properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/business/sale/sold", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "unconditionalSince", "value": "", "type": "query", "description": "Filter results with unconditional date since this date" }, { "name": "unconditionalBefore", "value": "", "type": "query", "description": "Filter results with unconditional date before this date" }, { "name": "settlementSince", "value": "", "type": "query", "description": "Filter results with settlement date since this date" }, { "name": "settlementBefore", "value": "", "type": "query", "description": "Filter results with settlement date before this date" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sold business properties" } ] }, { "info": { "name": "holidayRentalProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of holiday rental properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/holidayRental/lease", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "priceReducedSince", "value": "", "type": "query", "description": "Filter results by price reductions since this datetime" }, { "name": "priceReducedBefore", "value": "", "type": "query", "description": "Filter results by price reductions before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "publishedOnPortals", "value": "", "type": "query", "description": "Filter properties published to at least one of these office portal IDs" }, { "name": "listingAuthoritySince", "value": "", "type": "query", "description": "Filter results with listing authority date since this datetime" }, { "name": "listingAuthorityBefore", "value": "", "type": "query", "description": "Filter results with listing authority date before this datetime" }, { "name": "webLiveDateSince", "value": "", "type": "query", "description": "Filter results with web live date since this datetime" }, { "name": "webLiveDateBefore", "value": "", "type": "query", "description": "Filter results with web live date before this datetime" }, { "name": "status", "value": "", "type": "query", "description": "Filter by a list of statuses" }, { "name": "availableOnly", "value": "", "type": "query", "description": "Filter available lease properties only" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of holiday rental properties" }, { "info": { "name": "Add a holiday rental property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/holidayRental/lease", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a holiday rental property" }, { "info": { "name": "Retrieve a list of available holiday rental properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/holidayRental/lease/available", "params": [ { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "name": "suburbs", "value": "", "type": "query", "description": "Filter properties in these suburb IDs" }, { "name": "branches", "value": "", "type": "query", "description": "Filter properties in these account branch IDs" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of available holiday rental properties. This is the same as the /properties/holidayRental/lease endpoint, with certain filters pre-applied." }, { "info": { "name": "Retrieve a single holiday rental property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/holidayRental/lease/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single holiday rental property" }, { "info": { "name": "Update a holiday rental property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/holidayRental/lease/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the property" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a holiday rental property" } ] }, { "info": { "name": "suggest", "type": "folder" }, "items": [ { "info": { "name": "Search for a suburb", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suggest/suburb", "params": [ { "name": "term", "value": "", "type": "query", "description": "The suburb name (partial match) or postcode (exact match) to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for a suburb" }, { "info": { "name": "Search for an address in CoreLogic", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suggest/address/corelogic", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for an address in CoreLogic" } ] }, { "info": { "name": "corelogic", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a property from CoreLogic", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/corelogic/properties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "CoreLogic ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a property from CoreLogic using the CoreLogic property ID" }, { "info": { "name": "Retrieve an AVM estimate for this CoreLogic property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/corelogic/properties/:id/avm", "params": [ { "name": "id", "value": "", "type": "path", "description": "CoreLogic ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve an AVM estimate for this CoreLogic property" }, { "info": { "name": "Retrieve a rental AVM estimate for this CoreLogic property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/corelogic/properties/:id/rentalavm", "params": [ { "name": "id", "value": "", "type": "path", "description": "CoreLogic ID of the property" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a rental AVM estimate for this CoreLogic property" }, { "info": { "name": "Retrieve CoreLogic disclaimers", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/corelogic/disclaimers", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve CoreLogic disclaimers" } ] }, { "info": { "name": "search", "type": "folder" }, "items": [ { "info": { "name": "Search for properties by address", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/properties/address", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for properties by address" }, { "info": { "name": "Search for contacts by name", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/contacts/name", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "archived", "value": "", "type": "query", "description": "Filter by archived status" }, { "name": "marketingUser", "value": "", "type": "query", "description": "Filter by marketing user" }, { "name": "marketingUserPosition", "value": "", "type": "query", "description": "Used in conjuction with marketingUser, filter by marketing user position ID" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for contacts by name" }, { "info": { "name": "Search for contacts by phone number (exact match)", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/contacts/phone", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "archived", "value": "", "type": "query", "description": "Filter by archived status" }, { "name": "marketingUser", "value": "", "type": "query", "description": "Filter by marketing user" }, { "name": "marketingUserPosition", "value": "", "type": "query", "description": "Used in conjuction with marketingUser, filter by marketing user position ID" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for contacts by phone number (exact match)" }, { "info": { "name": "Search for contacts by email address (exact match)", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/contacts/email", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "archived", "value": "", "type": "query", "description": "Filter by archived status" }, { "name": "marketingUser", "value": "", "type": "query", "description": "Filter by marketing user" }, { "name": "marketingUserPosition", "value": "", "type": "query", "description": "Used in conjuction with marketingUser, filter by marketing user position ID" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for contacts by email address (exact match)" }, { "info": { "name": "Search for buildings by name", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/buildings/name", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for buildings by name" }, { "info": { "name": "Search for contact categories by name", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/contactCategories/name", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search by" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for contact categories by name" } ] }, { "info": { "name": "calendar", "type": "folder" }, "items": [ { "info": { "name": "Get a list of calendar events for the user or account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/calendar/events", "params": [ { "name": "startingAfter", "value": "", "type": "query", "description": "Filter events starting on or after this datetime" }, { "name": "startingBefore", "value": "", "type": "query", "description": "Filter events starting before this datetime" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get a list of calendar events for the user or account" }, { "info": { "name": "Add a calendar event", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/calendar/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a calendar event" }, { "info": { "name": "Get a single calendar event", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/calendar/events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the calendar event" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get a single calendar event" }, { "info": { "name": "Update a calendar event", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/calendar/events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the calendar event" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a calendar event" }, { "info": { "name": "Delete a calendar event", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/calendar/events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the calendar event" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a calendar event" } ] }, { "info": { "name": "tasks", "type": "folder" }, "items": [ { "info": { "name": "Get a list of tasks for the account or user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks", "params": [ { "name": "startingAfter", "value": "", "type": "query", "description": "Filter tasks starting on or after this datetime" }, { "name": "startingBefore", "value": "", "type": "query", "description": "Filter tasks starting before this datetime" }, { "name": "userid", "value": "", "type": "query", "description": "Filter tasks assigned to this user ID" }, { "name": "completed", "value": "", "type": "query", "description": "Filter tasks by completed status" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get a list of tasks for the account or user" }, { "info": { "name": "Add a task", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a task" }, { "info": { "name": "Get a single task", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the task" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get a single task" }, { "info": { "name": "Update a task", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the task" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a task" }, { "info": { "name": "Delete a task", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the task" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a task" }, { "info": { "name": "Mark the task as completed", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks/:id/complete", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the task" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Mark the task as uncompleted" }, { "info": { "name": "Mark the task as incomplete", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/tasks/:id/uncomplete", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the task" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Mark the task as incomplete" } ] }, { "info": { "name": "enquiries", "type": "folder" }, "items": [ { "info": { "name": "Get a list of enquiries from the holding area", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/enquiries", "params": [ { "name": "enquiryDateSince", "value": "", "type": "query", "description": "Filter enquiries occuring on or after this datetime" }, { "name": "enquiryDateBefore", "value": "", "type": "query", "description": "Filter enquiries occuring before this datetime" }, { "name": "processed", "value": "", "type": "query", "description": "Filter enquiries that have been processed or unprocessed" }, { "name": "saleLifeId", "value": "", "type": "query", "description": "Filter enquiries for this sale life ID" }, { "name": "leaseLifeId", "value": "", "type": "query", "description": "Filter enquiries for this lease life ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get a list of enquiries from the holding area" }, { "info": { "name": "Submit a listing enquiry", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/enquiries", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Submit a listing enquiry (e.g. from a franchise/portal site). If you are submitting enquiries from your \"office website\", please use the value \"OFFICEWEBSITE\" for the \"source\" field." } ] }, { "info": { "name": "propertyStats", "type": "folder" }, "items": [ { "info": { "name": "Update cumulative portal stats for a property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/property/portalStats/cumulative", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update cumulative portal stats for a property (e.g. listing views). If you want to track views day by day, use this endpoint." }, { "info": { "name": "Update total portal stats for a property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/property/portalStats/total", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update total portal stats for a property (e.g. listing views). If you only track a total figure for stats, use this endpoint." } ] }, { "info": { "name": "templates", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of email templates", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/email", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of email templates" }, { "info": { "name": "Create an email template", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/email", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create an email template" }, { "info": { "name": "Retrieve a single email template", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/email/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the template" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single email template" }, { "info": { "name": "Update an email template", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/email/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the template" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an email template" }, { "info": { "name": "Retrieve a list of SMS templates", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/sms", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of SMS templates" }, { "info": { "name": "Create an SMS template", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/sms", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create an SMS template" }, { "info": { "name": "Retrieve a single SMS template", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/sms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the template" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single SMS template" }, { "info": { "name": "Update an SMS template", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/sms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the template" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an SMS template" }, { "info": { "name": "Retrieve a list of owner summary templates", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/ownerSummary", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of owner summary templates" }, { "info": { "name": "Create an Owner Summary template", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/ownerSummary", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create an Owner Summary template" }, { "info": { "name": "Retrieve a single Owner Summary template", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/ownerSummary/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the template" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single Owner Summary template" }, { "info": { "name": "Update an Owner Summary template", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/templates/ownerSummary/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the template" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an Owner Summary template" } ] }, { "info": { "name": "maintenance", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of all maintenance jobs for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/maintenance", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "completed", "value": "", "type": "query", "description": "Filter maintenance jobs by their completed status" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of all maintenance jobs for this account" } ] }, { "info": { "name": "suppliers", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of suppliers", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of suppliers" }, { "info": { "name": "Create a supplier", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create a supplier" }, { "info": { "name": "Retrieve a single supplier", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the supplier" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single supplier" }, { "info": { "name": "Update a single supplier", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the supplier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a single supplier" }, { "info": { "name": "Delete a supplier", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the supplier" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete a supplier" }, { "info": { "name": "Retrieve a supplier's insurance", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers/:id/insurance", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the supplier" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a supplier's insurance" }, { "info": { "name": "Update a single supplier's insurance", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers/:id/insurance", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the supplier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a single supplier's insurance" }, { "info": { "name": "Retrieve a list of categories to which this supplier belongs", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suppliers/:id/categories", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the supplier" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of categories to which this supplier belongs" } ] }, { "info": { "name": "tenancies", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of residential tenancies", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/residential/lease/tenancies", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of residential tenancies" } ] }, { "info": { "name": "bulk", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of contact notes", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/bulk/contactNotes", "params": [ { "name": "types", "value": "", "type": "query", "description": "Filter notes with type IDs" }, { "name": "after", "value": "", "type": "query", "description": "Filter records after this ID" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of contact notes" }, { "info": { "name": "Retrieve a list of property inspections", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/bulk/inspections", "params": [ { "name": "after", "value": "", "type": "query", "description": "Filter records after this ID" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of property inspections" }, { "info": { "name": "Retrieve a list of feedback items", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/bulk/feedback", "params": [ { "name": "feedbackAfter", "value": "", "type": "query", "description": "Filter feedback occurring on or after this date" }, { "name": "feedbackBefore", "value": "", "type": "query", "description": "Filter feedback occurring before this date" }, { "name": "after", "value": "", "type": "query", "description": "Filter records after this ID" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "modifiedSince", "value": "", "type": "query", "description": "Filter results modified since this datetime" }, { "name": "modifiedBefore", "value": "", "type": "query", "description": "Filter results modified before this datetime" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of feedback items" } ] }, { "info": { "name": "deals", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of sale deals for this (commercial) property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/deals/sale", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of sale deals for this (commercial) property. This includes the agency's deals and external deals that have been tracked." }, { "info": { "name": "Retrieve a list of lease deals for this (commercial) property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/properties/:propertyid/deals/lease", "params": [ { "name": "propertyid", "value": "", "type": "path", "description": "ID of the property" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of lease deals for this (commercial) property. This includes the agency's deals and external deals that have been tracked." } ] }, { "info": { "name": "suburbs", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of suburbs for the user's country", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/suburbs", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of suburbs for the user's country" } ] }, { "info": { "name": "messages", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all received messages", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/messages/received", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve all received messages" }, { "info": { "name": "Retrieve all sent messages", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/messages/sent", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve all sent messages" }, { "info": { "name": "Retrieve all message threads", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve all message threads" }, { "info": { "name": "Add a franchise thread", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads/franchise", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a franchise thread" }, { "info": { "name": "Add a user message thread", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads/user", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a user message thread" }, { "info": { "name": "Update a message thread", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the message thread" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update a message thread" }, { "info": { "name": "Retrieve all messages in a thread", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads/:id/messages", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve all messages in a thread" }, { "info": { "name": "Add a message to a thread", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads/:id/messages", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the message thread" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a message to a thread" }, { "info": { "name": "Mark all messages in a thread as read by the current user", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/threads/:id/markRead", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the message thread" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Mark all messages in a thread as read by the current user" }, { "info": { "name": "Get all threads with the supplied recipients", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/threads/recipients", "params": [ { "name": "recipients", "value": "", "type": "query", "description": "Recipient ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get all threads with the supplied recipients. The user will be added automatically if not supplied." }, { "info": { "name": "Get all threads with the supplied recipients", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/threads/staffTypes", "params": [ { "name": "staffTypes", "value": "", "type": "query", "description": "Staff Type ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Get all threads with the supplied recipients." }, { "info": { "name": "Search for message threads containing term", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/search/threads/term", "params": [ { "name": "term", "value": "", "type": "query", "description": "The term to search for." }, { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Search for message threads containing term" } ] }, { "info": { "name": "advertising", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of advertising suppliers", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/advertising/suppliers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number of results" }, { "name": "pagesize", "value": "", "type": "query", "description": "Number of records to be returned in each page." }, { "name": "sort", "value": "", "type": "query", "description": "Field by which to sort the results." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order by which to sort the results. Used in conjunction with sort parameter." } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a list of advertising suppliers" }, { "info": { "name": "Add a new advertising supplier", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/advertising/suppliers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a new advertising supplier" }, { "info": { "name": "Retrieve a single advertising supplier", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/advertising/suppliers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the advertising supplier" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Retrieve a single advertising supplier" }, { "info": { "name": "Update an advertising supplier", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/advertising/suppliers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the advertising supplier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update an advertising supplier" }, { "info": { "name": "Delete an advertising supplier", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.2/advertising/suppliers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the advertising supplier" } ], "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Delete an advertising supplier" } ] } ], "bundled": true }