Acquaint Integrators Api

Getting Started

Contact the Development Team at Bright Logic (development@brightlogic.co.uk) for an API Key and Site Prefix

Obtain a JWT Token by calling https://api.integrators.acquaintcrm.co.uk/v1/auth, passing your API Key and Site Prefix. All subsequent API calls will require the JWT Token to be provided as a Bearer Token in the Authorization header. The JWT Token has a 1 hour lifetime

You are now ready to call other API endpoints

Testing in Swagger

The Swagger documentation can be found here.

Once you have a JWT Token generated via the auth endpoint, enter "bearer {jwt_token}" into the Swagger api_key field located on the top of the page and click Explore. You will now be able to test all endpoints within Swagger.

Using Postman

From within Postman, you can create a new collection of our endpoints by clicking "Import" and entering the following URL: https://api.integrators.acquaintcrm.co.uk/swagger/v1/docs

Using Bright Logic's Test Application

We've developed a .NET C# test application that you can download from Github to demonstrate how to implement and use the endpoints: https://github.com/bright-logic-ltd/Acquaint.Integrators.Api.Demo

Rate Limiting

We limit requests to 100 request per minute, per endpoint, per ip address, per api key.

Data Concepts

Each Acquaint customer has their own separate relational database. Each customer database will have a unique API Key and Site Prefix.

The Contacts table in Acquaint is used to store types of people such as Users, Applicants, Landlords, Vendors etc. determined by the TypeID field. Note that customers can also define their own custom Types, Statuses, Sources, Titles etc.

Endpoint such as /Contacts/list will allow filtering on TypeID and various other fields. For instance, you can request a list of Current Applicants called John Smith (using filter fields of status, type, firstNames and lastName).

Most tables will cross reference other tables by means of IDs. e.g. Properties are owned by a Landlord or Vendor so the ContactID field within the Properties model can be used to obtain the full Contact details via /Contacts/{id}.

Tables like PropertyOffers will be linked to Properties and also to multiple Contacts – contactId (the applicant making the offer), solicitorId, addedByUserid.

Data Constants

Many configuration settings are customisable in Acquaint, however some are fixed constants and can be viewed in the following XML document: https://www.acquaintcrm.co.uk/datafeeds/standardxml/constants.xml

List Concepts

All list endpoints are paginated. Pagination can be accessed via the following request query parameters:

Name	Default Value	Max Value
currentPage	1	N/A
pageSize	1000	1000

The response of each list endpoint is wrapped in a 'pagination envelope' defining the details of the pagination.

e.g.

                    {

                      "pagination": {

                        "currentPage": 0,

                        "pageSize": 0, 

                        "totalPages": 0, 

                        "totalRecords": 0 

                      }, 

                      "data": [] 

                    }

If the currentPage request query parameter is greater than the total number of pages, the 'pagination envelope' response will be returned with a blank data array.

Date Concepts

All dates on the API are in GMT, and must be provided as GMT. They're displayed in the standard ISO 8601 format. For example, October 1st 2024 at 4:05PM is 2024-10-01T16:05:00.