Skip to main content

Rex API

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

Bryn Humble avatar
Written by Bryn Humble
Updated this week

Set-Up

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

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

The following jobs run to syncronise data.

Listings

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

Fields For Listings Table

Rex Data

Field Name

Field Type

listing.property.system_search_key

_Address

single line text

Sale

_Type

single select

listing.system_listing_state

_Status

single select

listing.system_publication_status

_Marketing_Status

single select

False

_Is_Hidden_Listing

check box

listing.system_listing_state == 'draft'

_Is_Off_Market_Listing

check box

listing.authority_type.text

_Authority_Type

single select

listing.authority_type

_Method_Type

single select

listing.authority_date_start

_Listing_Date

date

listing.authority_date_expires

_Expiry_Date

date

listing.system_publication_time

_Launch_Date

date

listing.price_advertise_as

_Display_Price

single line text

listing.price_match

_Search_Price

currency

listing.price_match

_Listed_Price

currency

listing.state_value_price

_Sold_Price

currency

listing.state_date

_Sold_Date

date

listing.property.attr_bedrooms

_Bedrooms

number

listing.property.attr_bathrooms

_Bathrooms

number

listing.property.attr_total_car_accom

_Parking

number

listing._related.listing_events.event_date

_Auction_Date

date

listing._related.property_features._feature_name

_Features

multiple select

listing.comm_amount_fixed

_Commission_Type

single select

listing.comm_amount_percentage

_Commission_Rate

number

listing.comm_is_inc_tax == True

_Commission_IncGst

check box

contracts.date_actual_offer

_Contract_Date

date

contracts.date_expec_unconditional

_Expected_Unconditional

date

contracts.date_expec_unconditional

_Observed_Unconditional

date

contracts.date_expec_settlement

_Expected_Settle_Date

date

contracts.date_expec_settlement

_Observed_Settle_Date

date

contracts.detail_sale_price_or_lease_pa

_Contract_Price

currency

Internal record Id

_Record_Id

single line text

Id of the primary agent

_Related_Agent_1

number

Id of the secondary agent

_Related_Agent_2

number

Agents

The listings job feeds listings from Rex. The job runs once a day updating any records that have been modified in Rex since the last run time.

Fields For Listings Table

Rex 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

Email

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

Did this answer your question?