Skip to content

Get started

  Less than to read

  1. Install Sage CRM.

    RESTful API is enabled in Sage CRM by default.

  2. Configure your app or REST client to send HTTP requests using the following Authorization header and URL format.

    Authorization header

     Authorization: Basic {credentials}

    Where {credentials} is the user name and password of your Sage CRM account separated by a colon (:) and encoded in Base64. Your account must have logon permissions in Sage CRM. Disabled accounts and resource accounts do not have access to the RESTful API.

    URL format



    • {server} is the Sage CRM server name or IP address.
    • {installName} is the Sage CRM installation name specified in the Setup Wizard. The default installation name is crm.
    • {resource} is the Sage CRM resource you want to access.

    If you keep the default installation name in the Setup Wizard, the RESTful API access URL is as follows:


Using Postman

To see the RESTful API in action, you can use Postman, a multiplatform REST client with intuitive GUI for configuring HTTP requests, designing JSON payloads, and viewing HTTP responses.

We have prepared a Postman collection demonstrating how to create, retrieve, update, and delete records in Sage CRM via the RESTful API.

For steps on how to download and use the Postman collection, go to the home page, select the RESTful API reference for your Sage CRM version, and see the Postman collection section.

Sage CRM help and guides

For detailed Sage CRM documentation, go to the Sage CRM Help Center.