Retrieving People's Contact Details - V4 Contacts API

The following article should outline how to retrieve people's contact details from the system using the V4 Contacts API.

As contact information is GDPR restricted, the API will only return the contact details of people who have provided consent to be contacted by third party marketing sources. Any users without GDPR consent will return with a boolean GDPRConsent set to be false, and all sensitive information with be set to null in the response data.

Accessing Branch ID

Most endpoints in the Contacts 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/contacts/{shortName}/company/branches/{offset}/{count}

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 Applicants

Retrieving Lettings Applicants

Lettings applicants can be retrieved from the system by passing the ID of the branch you wish to look up the lettings applicants for into the following endpoint:

GET/v4/contacts/{shortName}/applicants/lettings/{offset}/{count}

This will return a collection of the lettings applicants set up against the branch, along with their contact details.

Retrieving Sales Applicants

Sales applicants can be retrieved from the system by passing the ID of the branch you wish to look up the sales applicants for into the following endpoint:

GET /v4/contacts/{shortName}/applicants/sales/{offset}/{count}

This will return a collection of the sales applicants set up against the branch, along with their contact details, and additional information regarding their requirements.

Retrieving Landlord Details

Landlord details can be retrieved from the system by passing the ID of the branch you wish to look up the landlords for into the following endpoint:

GET /v4/contacts/{shortName}/landlords/{offset}/{count}

This will return a collection of the landlords set up against the branch, along with their contact details.

Retrieving Tenants

Tenant details can be retrieved from the system by passing the ID of the branch you wish to look up the tenant for into the following endpoint:

GET /v4/contacts/{shortName}/tenants/{offset}/{count}

This will return a collection of the tenants set up against the branch, along with their contact details.

Retrieving Vendors

Vendor details can be retrieved from the system by passing the ID of the branch you wish to look up the vendors for into the following endpoint:

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

This will return a collection of the vendors set up against the branch, along with their contact details.