Skip to main content
Agentbox API

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

Bryn Humble avatar
Written by Bryn Humble
Updated over 4 months ago

Set-Up

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

If there are multiple Agentbox 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 Agentbox, only selected data that is provided by the Agentbox API.

The following jobs run to syncronise data.

Listings

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

Fields For Listings Table

Agentbox Data

Field Name

Field Type

property.address.streetAddress

Address

single line text

type

Type

single select

status

Status

single select

marketingStatus

Marketing_Status

single select

hiddenListing

Is_Hidden_Listing

check box

offMarketListing

Is_Off_Market_Listing

check box

webLink

Web_Link

URL

authority

Authority_Type

single select

method

Method_Type

single select

listedDate

Listing_Date

date

expiryDate

Expiry_Date

date

expectedOnMarketDate

Launch_Date

date

displayPrice

Display_Price

single line text

searchPrice

Search_Price

currency

listedPrice.value

Listed_Price

currency

listedRent.value

Listed_Price

currency

soldPrice

Sold_Price

currency

soldDate

Sold_Date

date

property.bedrooms

Bedrooms

number

property.bathrooms

Bathrooms

number

property.totalParking

Parking

number

auctionDate

Auction_Date

date

property.features

Features

multiple select

grossCommissionFeeStructure.type

Commission_Type

single select

grossCommissionFeeStructure.rate

Commission_Rate

number

contractDetails.contractDate

Contract_Date

date

contractDetails.expectedUnconditionalDate

Expected_Unconditional

date

contractDetails.unconditionalDate

Observed_Unconditional

date

contractDetails.expectedSettlementDate

Expected_Settle_Date

date

contractDetails.settledDate

Observed_Settle_Date

date

contractDetails.price

Contract_Price

currency

id

Record_Id

single line text

Did this answer your question?