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 |
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 |
Link to agents table | _Related_Agent_1 | link |
Link to agents table | _Related_Agent_2 | link |
id | _Record_Id | single line text |
Agents
The listings job feeds listings from Agentbox. The job runs once a day updating any records that have been modified in Agentbox since the last run time.
Fields For Listings Table
Agentbox Data | Field Name | Field Type |
id | _Record_Id | single line text |
Fist name | First_Name | single line text |
Last name | Last_Name | single line text |
Email address | single line text | |
Full name | Name | single line text |
Linking Jobs
Linking jobs link data between tables. There are four fields that are involved, two ID fields and two link fields. The API will match records based on the ID fields and link the data using the corresponding link fields for that record. The following links are available, defined by the link between Table A and (->) Table B. Linking threads run every hour.
Listings -> Agents (For Agent 1)
Data | Field Name | Field Type |
Id of Table A | _Record_Id | Text |
Id of Table B | _Related_Agent_1 | Text |
Link in Table A | Agent 1 | Link |
Link in Table B | Listing | Link |
Listings -> Agents (For Agent 2)
Data | Field Name | Field Type |
Id of Table A | _Record_Id | Text |
Id of Table B | _Related_Agent_2 | Text |
Link in Table A | Agent 2 | Link |
Link in Table B | Listing | Link |