Sage CRM REST API

Unofficial REST API for Sage CRM

What is REST API for Sage CRM?

Our REST API for Sage CRM is a simple and powerful web service based on REST principles and it was developed to let you connect Sage CRM with external applications.

The API exposes ways to manipulate Sage CRM data via REST resources and HTTP methods. You can create, read, update, and delete (CRUD) records, search or query your data. Requests are made via HTTPS using GET, POST, PUT or  DELETE methods, responses are sent in JSON format,  while access to the REST API is secured with oAuth 2.0 and authorization tokens.

Why?

A growing demand for integration of Sage CRM with external applications.

The REST API has a lightweight request and response framework, it is easy to use use from almost all programming languages and it’s great for writing mobile and web applications or transfer data between Sage CRM and various systems and platforms.

When to use REST API for Sage CRM?

A. For Developers 

REST API provides a powerful, convenient, and simple REST-based web services interface for interacting with Sage CRM. Its advantages include ease of integration and development, and it’s an excellent choice of technology for use with mobile applications and web projects or to build UI for creating, reading, updating, and deleting records or building UI for list views and actions

  • Easy to use API endpoints
  • JSON formatted request and response
  • HTTPS support
  • Secured with oAuth 2.0 and authorization token

Example:

GET request to retrieve Sage CRM tasks

https://{{serverURL}}/{{installName}}/CustomPages/LeadingEdge/api/tasks 

cURL:

curl --request GET \ --url 'https://{{serverURL}}/{{installName}}/CustomPages/LeadingEdge/API2/api/tasks'
 NODE
var http = require("https");

var options = {
"method": "GET",
"hostname": [
"{{serverURL}}"
],
"path": [
"{{installName}}",
"CustomPages",
"LeadingEdge",
"API2",
"api",
"tasks"
],
"headers": {}
};

var req = http.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
});

req.end();

JSON response

[
    {
        "due": "2018-08-25T09:00:00",
        "start": "2018-08-25T10:00:00",
        "status": "Pending",
        "action": "PhoneOut",
        "subject": "Followup call from Finance mailer",
        "notes": null,
        "priority": null,
        "user": 28,
        "company": "Dental Company",
        "person": "Michael Hallson",
        "id": 448
    },
    {
        "due": "2018-08-25T09:00:00",
        "start": "2018-08-25T10:00:00",
        "status": "Pending",
        "action": "ToDo",
        "subject": "Training requirement on Time Manager",
        "notes": null,
        "priority": null,
        "user": 28,
        "company":  "A&W Services",
        "person": "Bob Coomber",
        "id": 449
    }
]

To find out more checkout technical documentation for the Beta release or drop us an email

B. For Non Technical audience

APIs aren’t just for technical audiences and you don’t need to be a programmer to use one. All you need to know is how to use Zapier, because Zapier has made it easy for non-technical audiences to consume APIs with just a few clicks of a button.

Zapier is an online automation tool that connects your favorite apps, such as Gmail, Office 365, MailChimp, and over 1,000 more.

With Zapier you can connect two or more apps to automate repetitive tasks without coding or relying on developers to build the integration. You can move data between your web apps automatically, so you can focus on your most important work. It’s easy enough that anyone can build their own app workflows with just a few clicks.

Let’s say  a potential customer just contacted you via your Facebook Lead Ad. Great! How do you easily follow up with that person and keep the conversation going? Zapier can automatically enter that lead into Sage CRM, so you can start marketing the prospects right away.

The REST API for Sage CRM gives you the power to integrate Sage CRM via Zapier with all the web apps you use everyday: Gmail, Office 365, Google Calendar, Google Tasks, Facebook Leads Ad, QuickBooks Online, Freshbook, MailChimp, etc.

Check-out the following how-to examples:

  1. Google Calendar & Google Tasks integration with Sage CRM via Zapier
  2. Zapier Gmail  Sage CRM integration –
    1. automatically create Sage CRM case from GMail email
    2. create Sage CRM lead from GMail email
  3. Facebook Lead Ad – Facebook form data converted to Sage CRM  leads via Zapier
  4. Freshbooks Sage CRM integration – new client in Freshbooks is added as Company in Sage CRM via Zapier integration

*Currently, our Zapier integration is “Invite Only”.