> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# VaultRE Connector

## Intro

VaultRE is a technology developed specifically for the real estate industry. Its end goal is to offer a system that can give a business owner or franchiser the ability to monitor every aspect of their business or group from a single page, from any location and in real time.

You can create powerful visualizations and reports to track all the properties. Combine your VaultRE data with all your information on Domo and plan for future business demands. To learn more about the VaultRE

API, visit their page ([https://docs.api.vaultre.com.au/](https://docs.api.vaultre.com.au/)).

The VaultRE Connector is a "Cloud App" Connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the Connector page for this and other Cloud App Connectors by clicking **Cloud App** in the toolbar at the top of the window.

You connect to your VaultRE account in the Data Center. This topic discusses the fields and menus that are specific to the VaultRE Connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274).

## Prerequisites

To connect to your VaultRE account and create a DataSet, you must have the API key and access token associated with your VaultRE account.

## Connecting to Your VaultRE Account

This section enumerates the options in the Credentials and Details panes in the VaultRE Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274).

### Credentials Pane

This pane contains fields for entering credentials to connect to your VaultRE account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Field </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"> API Key </td><td colspan="1" rowspan="1"><span> Enter your VaultRE account's API key. </span></td></tr><tr><td colspan="1" rowspan="1"> Access Token </td><td colspan="1" rowspan="1"><span> Enter your VaultRE account's access token. </span></td></tr></tbody></table>

Once you have entered valid VaultRE credentials, you can use the same account any time you go to create a new VaultRE DataSet. You can manage Connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054).

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"> Reports </td><td colspan="1" rowspan="1"><table border="1"><tbody><tr><th colspan="1" rowspan="1"> Report </th><th colspan="1" rowspan="1"> Description </th></tr><tr><td colspan="1" rowspan="1"> Bulk Inspections </td><td colspan="1" rowspan="1"> Pulls bulk inspections data. </td></tr><tr><td colspan="1" rowspan="1"> Conjunctionals </td><td colspan="1" rowspan="1"> Retrieves a list of conjunctional property deals. </td></tr><tr><td colspan="1" rowspan="1"> Contact Contexts </td><td colspan="1" rowspan="1"> Calls /contacts and for each contact, gets the contact context data. This report makes API calls for every row. </td></tr><tr><td colspan="1" rowspan="1"> Contacts </td><td colspan="1" rowspan="1"> Pulls contacts data. </td></tr><tr><td colspan="1" rowspan="1"> Properties </td><td colspan="1" rowspan="1"> Pulls property data. </td></tr><tr><td colspan="1" rowspan="1"> Purchasers </td><td colspan="1" rowspan="1"> Calls /properties/sale and for each sale, gets the purchasers data (limited to 5 purchasers per sale to limit column number). This report makes API calls for every row. </td></tr><tr><td colspan="1" rowspan="1"> Vendors </td><td colspan="1" rowspan="1"> Calls /properties/sale and for each sale, gets the vendors data (limited to 5 vendors per sale to limit column number). This report makes API calls for every row. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"> Property Category </td><td colspan="1" rowspan="1"><p><span> Select the category for the property. </span></p><p><span> For example, 'Residential' uses the /properties/residential endpoint. 'All' uses the /properties endpoint. </span></p></td></tr><tr><td colspan="1" rowspan="1"> Property Status </td><td colspan="1" rowspan="1"><p><span> Select the status for the property category. </span></p><p><span> For example, property category 'Residential' and property status 'Sale' uses the /properties/residential/sale endpoint. Property status 'All' would use the /properties/residential endpoint. </span></p></td></tr><tr><td colspan="1" rowspan="1"> Fetch data based on the selected date </td><td colspan="1" rowspan="1"> Select this checkbox if you want to pull the data based on the selected date, otherwise, the connector will pull data after the last time it was run. If the selected report is <b> Bulk Inspections </b>, then selecting this checkbox will bring all the data. </td></tr><tr><td colspan="1" rowspan="1"> Number Of Columns To Unnest </td><td colspan="1" rowspan="1"><p><span> Select report as Properties, Property Category as Residential, Property Status as Sold. After this, the number of columns to unnest will get displayed on the UI. </span></p><p><span> Enter the number of columns you would like to unnest from the data. <br /><b> NOTE: </b> The max number of allowed columns is 132. Default is 20. </span></p></td></tr><tr><td colspan="1" rowspan="1"> Page Size </td><td colspan="1" rowspan="1"> Select <b> Page Size </b> to accept the number of records to be fetched per page. </td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the Connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274).

## FAQs

<AccordionGroup>
  <Accordion title="When should I use this connector?">
    This connector allows you to bring your VaultRE data into Domo using an API token for authentication.
  </Accordion>

  <Accordion title="What endpoint is the base URL for this connector?">
    The base URL for this connector is [https://ap-southeast-2.api.vaultre.com.au/api](https://ap-southeast-2.api.vaultre.com.au/api)
  </Accordion>

  <Accordion title="Which endpoint(s) does each report call in this connector?">
    <table data-aura-rendered-by="33:195;a"><tbody><tr><th colspan="1" rowspan="1" width="30%"> Report Name </th><th colspan="1" rowspan="1" width="70%"> Endpoint URL </th></tr><tr><td colspan="1" rowspan="1"> Bulk Inspections </td><td colspan="1" rowspan="1"> /v1.3/bulk/inspections </td></tr><tr><td colspan="1" rowspan="1"> Contact Contexts </td><td colspan="1" rowspan="1"> /v1.3/contacts/{id}/context </td></tr><tr><td colspan="1" rowspan="1"> Contacts </td><td colspan="1" rowspan="1"> /v1.3/contacts </td></tr><tr><td colspan="1" rowspan="1"> Properties </td><td colspan="1" rowspan="1"> /v1.3/properties </td></tr><tr><td colspan="1" rowspan="1"> Purchasers </td><td colspan="1" rowspan="1"> /v1.3/properties/{id}/sale/{lifeId}/purchasers </td></tr><tr><td colspan="1" rowspan="1"> Vendors </td><td colspan="1" rowspan="1"> /v1.3/properties/{id}/sale/{lifeId}/owners </td></tr></tbody></table>
  </Accordion>

  <Accordion title="What kind of credentials do I need to power up this connector?">
    You need the API key and access token associated with your VaultRE account.
  </Accordion>

  <Accordion title="How often can the data be updated?">
    As often as needed.
  </Accordion>

  <Accordion title="Are there any API limits that I need to be aware of?">
    No
  </Accordion>
</AccordionGroup>