Table of Contents
Lettings Software & Property Management for Letting Agents, Sales Software for Estate Agents, Websites Acquaint is powerful, easy to use & cost-effective.
API Overview
Acquaint CRM is a comprehensive customer relationship management (CRM) solution designed to streamline business processes and enhance customer engagement. It offers a suite of robust features, including contact management, lead tracking, sales automation, marketing automation, and reporting and analytics. Acquaint CRM empowers businesses to centralize customer data, automate workflows, and gain valuable insights into customer behavior. Its user-friendly interface and customizable features make it suitable for businesses of all sizes and industries.
Acquaint CRM API offers a comprehensive set of RESTful APIs that enable seamless integration with external systems and applications. The well-documented API allows developers to access and manipulate CRM data, automate tasks, and extend the functionality of Acquaint CRM. Webhooks provide real-time notifications of events within the CRM, allowing businesses to respond swiftly to customer interactions and trigger automated actions. The API also enforces rate limits to prevent excessive API usage and ensure optimal performance for all users. By leveraging the Acquaint CRM API, businesses can unlock the full potential of the CRM and enhance their customer relationship management capabilities.
API Request Limits
Free Plan
100 requests per minute
Starter Plan
1,000 requests per minute
Professional Plan
5,000 requests per minute
Enterprise Plan
10,000 requests per minute
SDKs
APIs
Method: get
Description: Get a list of addresses..
Endpoint: addresses
Parameters:
Method: post
Description: Create a new address..
Endpoint: addresses
Parameters: address_line_1, address_line_2, town, county, postcode, country, customer_id
Method: put
Description: Update an address..
Endpoint: addresses/{id}
Parameters: id, address_line_1, address_line_2, town, county, postcode, country, customer_id
Method: delete
Description: Delete an address..
Endpoint: addresses/{id}
Parameters: id
Method: get
Description: Get a list of attachments..
Endpoint: attachments
Parameters:
Method: post
Description: Create a new attachment..
Endpoint: attachments
Parameters: file, description, attachable_type, attachable_id
Method: delete
Description: Delete an attachment..
Endpoint: attachments/{id}
Parameters: id
Method: get
Description: Get a list of campaigns..
Endpoint: campaigns
Parameters:
Method: post
Description: Create a new campaign..
Endpoint: campaigns
Parameters: name, description, start_date, end_date, budget
Method: put
Description: Update a campaign..
Endpoint: campaigns/{id}
Parameters: id, name, description, start_date, end_date, budget
Method: delete
Description: Delete a campaign..
Endpoint: campaigns/{id}
Parameters: id
Method: get
Description: Get a list of contacts..
Endpoint: contacts
Parameters:
Method: post
Description: Create a new contact..
Endpoint: contacts
Parameters: first_name, last_name, email, phone, mobile, title, company, job_title, website, linkedin, twitter, facebook, notes
Method: put
Description: Update a contact..
Endpoint: contacts/{id}
Parameters: id, first_name, last_name, email, phone, mobile, title, company, job_title, website, linkedin, twitter, facebook, notes
Method: delete
Description: Delete a contact..
Endpoint: contacts/{id}
Parameters: id
Method: get
Description: Get a list of customers..
Endpoint: customers
Parameters:
Method: post
Description: Create a new customer..
Endpoint: customers
Parameters: name, email, phone, mobile, website, linkedin, twitter, facebook, notes
Method: put
Description: Update a customer..
Endpoint: customers/{id}
Parameters: id, name, email, phone, mobile, website, linkedin, twitter, facebook, notes
Method: delete
Description: Delete a customer..
Endpoint: customers/{id}
Parameters: id
Method: get
Description: Get a list of deals..
Endpoint: deals
Parameters:
Method: post
Description: Create a new deal..
Endpoint: deals
Parameters: name, description, stage, value, close_date, customer_id
Method: put
Description: Update a deal..
Endpoint: deals/{id}
Parameters: id, name, description, stage, value, close_date, customer_id
Method: delete
Description: Delete a deal..
Endpoint: deals/{id}
Parameters: id
Method: get
Description: Get a list of emails..
Endpoint: emails
Parameters:
Method: post
Description: Create a new email..
Endpoint: emails
Parameters: subject, body, from_name, from_email, to_name, to_email, cc, bcc, attachments
Method: delete
Description: Delete an email..
Endpoint: emails/{id}
Parameters: id
Method: get
Description: Get a list of events..
Endpoint: events
Parameters:
Method: post
Description: Create a new event..
Endpoint: events
Parameters: name, description, start_date, end_date, location, customer_id
Method: put
Description: Update an event..
Endpoint: events/{id}
Parameters: id, name, description, start_date, end_date, location, customer_id
Method: delete
Description: Delete an event..
Endpoint: events/{id}
Parameters: id
Method: get
Description: Get a list of invoices..
Endpoint: invoices
Parameters:
Method: post
Description: Create a new invoice..
Endpoint: invoices
Parameters: customer_id, invoice_date, due_date, line_items
Method: put
Description: Update an invoice..
Endpoint: invoices/{id}
Parameters: id, customer_id, invoice_date, due_date, line_items
Method: delete
Description: Delete an invoice..
Endpoint: invoices/{id}
Parameters: id
Method: get
Description: Get a list of leads..
Endpoint: leads
Parameters:
Method: post
Description: Create a new lead..
Endpoint: leads
Parameters: first_name, last_name, email, phone, mobile, company, job_title, website, linkedin, twitter, facebook, notes
Method: put
Description: Update a lead..
Endpoint: leads/{id}
Parameters: id, first_name, last_name, email, phone, mobile, company, job_title, website, linkedin, twitter, facebook, notes
Method: delete
Description: Delete a lead..
Endpoint: leads/{id}
Parameters: id
Method: post
Description: Create a new line item..
Endpoint: line_items
Parameters: invoice_id, description, quantity, unit_price, discount
Method: put
Description: Update a line item..
Endpoint: line_items/{id}
Parameters: id, invoice_id, description, quantity, unit_price, discount
Method: delete
Description: Delete a line item..
Endpoint: line_items/{id}
Parameters: id
Method: get
Description: Get a list of opportunities..
Endpoint: opportunities
Parameters:
Method: post
Description: Create a new opportunity..
Endpoint: opportunities
Parameters: name, description, stage, value, close_date, customer_id
Method: put
Description: Update an opportunity..
Endpoint: opportunities/{id}
Parameters: id, name, description, stage, value, close_date, customer_id
Method: delete
Description: Delete an opportunity..
Endpoint: opportunities/{id}
Parameters: id
Method: get
Description: Get a list of products..
Endpoint: products
Parameters:
Method: post
Description: Create a new product..
Endpoint: products
Parameters: name, description, price, cost, sku, quantity_on_hand
Method: put
Description: Update a product..
Endpoint: products/{id}
Parameters: id, name, description, price, cost, sku, quantity_on_hand
Method: delete
Description: Delete a product..
Endpoint: products/{id}
Parameters: id
Method: get
Description: Get a list of projects..
Endpoint: projects
Parameters:
Method: post
Description: Create a new project..
Endpoint: projects
Parameters: name, description, start_date, end_date, budget, customer_id
Method: put
Description: Update a project..
Endpoint: projects/{id}
Parameters: id, name, description, start_date, end_date, budget, customer_id
Method: delete
Description: Delete a project..
Endpoint: projects/{id}
Parameters: id
Method: get
Description: Get a list of quotes..
Endpoint: quotes
Parameters:
Method: post
Description: Create a new quote..
Endpoint: quotes
Parameters: customer_id, quote_date, expiry_date, line_items
Method: put
Description: Update a quote..
Endpoint: quotes/{id}
Parameters: id, customer_id, quote_date, expiry_date, line_items
Method: delete
Description: Delete a quote..
Endpoint: quotes/{id}
Parameters: id
Method: get
Description: Get a list of tasks..
Endpoint: tasks
Parameters:
Method: post
Description: Create a new task..
Endpoint: tasks
Parameters: name, description, due_date, priority, status, assignee_id
Method: put
Description: Update a task..
Endpoint: tasks/{id}
Parameters: id, name, description, due_date, priority, status, assignee_id
Method: delete
Description: Delete a task..
Endpoint: tasks/{id}
Parameters: id
Method: get
Description: Get a list of users..
Endpoint: users
Parameters:
Method: post
Description: Create a new user..
Endpoint: users
Parameters: first_name, last_name, email, password, role
Method: put
Description: Update a user..
Endpoint: users/{id}
Parameters: id, first_name, last_name, email, password, role
Method: delete
Description: Delete a user..
Endpoint: users/{id}
Parameters: id
FAQ
How do I authenticate with the Acquaint CRM API?
You can authenticate using OAuth 2.0 with the <code>client_credentials</code> grant type. Obtain credentials from the Acquaint CRM developer portal.
Are there any rate limits for API requests?
Yes, there are rate limits in place to prevent excessive usage. The specific limits vary depending on your subscription tier.
How do I get access to the sandbox environment?
Contact Acquaint CRM support to request access to a sandbox account, which allows you to test integrations without affecting live data.
How do I create a developer account?
Visit the Acquaint CRM developer portal and sign up for a free developer account to access documentation, sample code, and the sandbox environment.
What is the format of date and time values in the API?
Dates and times are represented in ISO 8601 format, using the <code>YYYY-MM-DD</code> and <code>YYYY-MM-DD HH:MM:SS</code> patterns respectively.