CRM (ShareBuilder CRM)
      Back to home
      1. Help Desk
      2. Development Resources
      3. CRM (ShareBuilder CRM)

      ShareBuilder CRM API

      To gain access to our Integration Partners, please complete the form below and select Request Vendor API Access. Once received, our team will verify your access request and provide you with your Client ID & Client Secret.

      Overview

      ShareBuilder's CRM APIs represent our mission to provide the industry's most integrated and open platform. Our APIs are designed to enable users of any shape or size to build robust integrations that help them customize and get the most value out of the ShareBuilder & ShareBuilder CRM platform.

      Our APIs are built using REST conventions and designed to have a user-friendly structure. They use many standard HTTP features, including methods (POST, GET, PUT) and error response codes. All of our CRM API calls are made under https://api.ShareBuilder CRMsolutions.com and all responses return standard JSON.

      Objects

      • Leads
      • Accounts
      • Agencies
      • Contacts
      • Activity
      • Billing
      • Users
      • Product Categories
      • Traffic Systems
      • Stations
      • Markets

      API Documentation

      Our development team provides API users with a ReDoc resource to help consumers better understand the data available within our platform. 

      https://crm-api.share-builders.com/docs/index.html

      Authentication

      There are two methods to access the CRM API Endpoints based on your integration needs. 

      1. As a User - Accessing the API as a user allows you to access the CRM market(s) that the user currently has access to. All actions taken through this authentication method perform those actions as that user and can not be changed. 
      2. As an Integration Partner - Access market databases from a single set of credentials without using a user's credentials. This is ideal for larger integrations between our CRM platform and a third-party service. This solution allows the integration partner to specify the user when creating objects or default to the house user if no match. 

      External Source IDs

      In many integrations, matching records can be difficult and can create a high probability of creating duplicate records if done incorrectly. Our APIs provide the ability to create and look up External Source IDs. These IDs could be created from your lead generation system, accounting solution, or data factory solution. 

      Currently, the following objects support External Source IDs:

      • Accounts
      • Leads
      • Contacts (Coming Soon)