Skip to main content

Vault API

This article will walk through the API between The Hub and Vault.

Bryn Humble avatar
Written by Bryn Humble
Updated this week

Set-Up

The Vault API requires authentication between STAFFLINK and Vault. Please allow up to two weeks for set up to be performed. Contact your Customer Success Manager to implement this.

If there are multiple Vault accounts, they can all be fed into the same base, or separate bases if that is preferred, each account will need to be authenticated one by one.

Once implemented, please do not change the names of any tables used by the API. Consequently, please also do not change any of the fields that the API feeds data into for each record. If you change data in any of the fields, the API will also overwrite it on the next run.

Not all data is available from Vault, only selected data that is provided by the Vault API.

The following jobs run to syncronise data.

Listings

The listings job feeds listings from Vault. The job runs every hour updating any records that have been modified in Vault since the last run time.

Fields For Listings Table

Vault Data

Field Name

Field Type

displayAddress

Address

single line text

id

Record_Id

single line text

saleData.status

Status

single select

saleData.portalStatus

Marketing_Status

single select

saleData.soldType.name

Method_Type

single select

saleData.listingAuthority

Listing_Date

date

saleData.conditional

Contract_Date

date

saleData.unconditional

Expected_Unconditional

date

saleData.settlement

Expected_Settle_Date

date

saleData.lifeId

Life_Id

single line text

property.bedrooms

Bedrooms

number

property.bathrooms

Bathrooms

number

property.totalParking

Parking

number

Did this answer your question?