Retrieving Concierge Managed Properties - V4 Concierge API

The following article should outline how to retrieve concierge managed properties from the system using the V4 Concierge API.

Accessing Branch ID

Most endpoints in the Concierge API require a branch ID in order to retrieve data. In order to retrieve the Branch ID, you will need to run the following endpoint located in the Company Controller:

GET /v4/concierge/{shortName}/company/branches/{branchID}

You will need to retain the value of the OID field for the branch you will want to search against in any other endpoints.

Retrieving Concierge Managed Tenancies

After retrieving the branch ID of the branch you wish to query, you will be able to retrieve a list of all concierge managed tenancies between two dates by using the following endpoint:

GET /v4/concierge/{shortName}/tenancies/conciergemanaged/{offset}/{count}

This will return a collection of all the active tenancies in the system between two dates that are set to be managed by a concierge.

Retrieving Tenants

Upon retrieving a list of Concierge managed tenancies, Tenant details can be retrieved by passing Tenant ID's into the following endpoint:

GET /v4/concierge/{shortName}/contacts/tenants/{tenantID}

This will return the contact details for the specified tenant.

Retrieving Properties

Upon retrieving a list of concierge managed tenancies, you will be able to retrieve the property associated with the concierge managed tenancy by passing the PropertyID into the following endpoint:

GET /v4/concierge/{shortName}/properties/{propertyID}

This will return the property details from the property associated with the ID.

Retrieving Landlords

Upon retrieving the tenancy property, a LandlordID will be returned. This LandlordID can then be passed into the following endpoint:

GET /v4/concierge/{shortName}/contacts/landlord/{landlordID}

This will then return the contact details of the landlord associated with the ID.

Retrieving Concierge Managed Sales Instructions

After retrieving the branch ID of the branch you wish to query, you will be able to retrieve a list of all concierge managed tenancies between two dates by using the following endpoint:

GET /v4/concierge/{shortName}/salesinstructions/conciergemanaged/{offset}/{count}

This will return a collection of all the active tenancies in the system between two dates that are set to be managed by a concierge.

Retrieving Purchaser

Upon retrieving a sales instruction, the sales instruction can be be passed into the following endpoint to retrieve the purchaser of a property:

GET /v4/concierge/{shortName}/contacts/purchasers

This will return the contact details set up against the purchaser on the accepted offer on a property.

Retrieving Vendors

Upon retrieving a sales instruction, you will be able to retrieve the vendors of the sale. There are two ways available to retrieve the vendors of a sales instruction.

The first method to return vendors is to retain the sales instruction's ID. This can then be passed into the following endpoint to retrieve vendors:

GET /v4/concierge/{shortName}/contacts/vendors/{offset}/{count}

This endpoint will return a collection of the contact details of all the vendors on a sales instruction.

Alternatively, you can retrieve vendors by looping through the array of vendor ID's on the sales instruction, and passing each ID into the following endpoint:

GET /v4/concierge/{shortName}/contacts/vendors/{vendorID}

This will return the contact details for the specific vendor associated with the vendor ID.