{ "opencollection": "1.0.0", "info": { "name": "VaultRE", "version": "1.1" }, "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.1/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.1/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.1/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.1/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.1/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.1/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": "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.1/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.1/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.1/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.1/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 note types for this account", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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": "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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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": "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" }, { "info": { "name": "Create a contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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.1/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 (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.1/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 (charges may apply). 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.1/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.1/contacts/recentlyAccessed", "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.1/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.1/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.1/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.1/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.1/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.1/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.1/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 a category to this contact", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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 a category 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.1/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": "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.1/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.1/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.1/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": "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.1/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.1/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.1/contacts/:id/requirements", "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 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.1/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.1/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.1/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.1/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": "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.1/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.1/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.1/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.1/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.1/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.1/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.1/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": "Update the credentials for the authenticated user", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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": "Log out from the current user session", "type": "http" }, "http": { "method": "DELETE", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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": "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.1/properties", "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": "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.1/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.1/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 notes attached to this property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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.1/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.1/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.1/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" }, { "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.1/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.1/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.1/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.1/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.1/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.1/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.1/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 files attached to this property life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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": "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" }, { "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.1/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.1/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.1/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": "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 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.1/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.1/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.1/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.1/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 list of open homes attached to this life", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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": "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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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 upcoming open homes", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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": "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.1/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": "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": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user 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 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.1/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 single residential sale property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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 residential lease properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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": "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": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "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": "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.1/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 single residential lease property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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": "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": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user 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 land properties" }, { "info": { "name": "Add a land property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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 single land property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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": "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.1/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": "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": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user 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 rural properties" }, { "info": { "name": "Add a rural property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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 single rural property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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": "commercialProperties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of commercial properties", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/properties/commercial/:salelease", "params": [ { "name": "salelease", "value": "", "type": "path", "description": "Filter by sale or lease properties" }, { "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": "published", "value": "", "type": "query", "description": "Filter properties published to at least one web portal" }, { "name": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user ID" }, { "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 properties" }, { "info": { "name": "Add a commercial property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/properties/commercial/:salelease", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Add a commercial property" }, { "info": { "name": "Retrieve a single commercial property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/properties/commercial/:salelease/:id", "params": [ { "name": "salelease", "value": "", "type": "path", "description": "Filter by sale or lease properties" }, { "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 property" }, { "info": { "name": "Update a commercial property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/properties/commercial/:salelease/:id", "params": [ { "name": "salelease", "value": "", "type": "path", "description": "Update sale or lease life" }, { "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 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.1/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": "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": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "name": "contactStaff", "value": "", "type": "query", "description": "Filter properties with contactStaff containing this user 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 business properties" }, { "info": { "name": "Add a business property", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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 single business property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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": "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.1/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": "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": "status", "value": "", "type": "query", "description": "Property status to filter by" }, { "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": "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.1/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 single holiday rental property", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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.1/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." } ], "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.1/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." } ], "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.1/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." } ], "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.1/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": "calendar", "type": "folder" }, "items": [ { "info": { "name": "Get a list of calendar events for the user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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" }, { "info": { "name": "Add a calendar event", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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 user", "type": "http" }, "http": { "method": "GET", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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": "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 user" }, { "info": { "name": "Add a task", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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.1/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.1/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.1/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.1/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.1/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": "Submit a listing enquiry", "type": "http" }, "http": { "method": "POST", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/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)" } ] }, { "info": { "name": "propertyStats", "type": "folder" }, "items": [ { "info": { "name": "Update portal stats for a property", "type": "http" }, "http": { "method": "PUT", "url": "https://ap-southeast-2.api.vaultre.com.au/api/v1.1/property/portalStats", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Update portal stats for a property (e.g. listing views)" } ] }, { "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.1/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.1/templates/email", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create 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.1/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.1/templates/sms", "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "docs": "Create an SMS template" } ] } ], "bundled": true }