Skip to main content
Gainsight Inc.

API Documentation Overview

Gainsight NXT

This article supports Gainsight NXT, the next evolution of the Customer Success platform. If you are using Gainsight CS Salesforce Edition, you can find supporting documentation by visiting the home page, and selecting CS > Salesforce Edition.

Not sure what your team is using? Click here.

 

API Documentation

For decades, businesses have used data to drive customer acquisition. Now, we’re changing the game for businesses by helping them leverage the power of customer data to manage at-risk customers and grow the lifetime value of healthy ones. Gainsight helps businesses gain insight into the Customer lifecycle, Risk Management, Value demonstration, Expansion and Advocacy, and Cross functional collaboration.

Gainsight APIs belong to the Representational State Transfer (REST) category. They allow you to perform 'RESTful' operations such as reading, modifying, adding or deleting data from your Gainsight tenant.

Gainsight offers REST APIs to integrate your applications or services with the Gainsight platform. Gainsight API documentation is intended to address developers who need to understand the Gainsight APIs before integrating applications and services with the Gainsight platform. Using these APIs, you can insert or update data into the Gainsight applications from external systems. Data which is upserted into Gainsight applications is stored in various objects in Gainsight’s Matrix Data Platform (MDA). Using these REST APIs, you can manipulate objects (Read/Write/Upsert/Delete) and insert or update upto 50 records in a single API call. If you want to perform bulk loading (inserting more than 50 records), you can use Gainsight Bulk API.

Gainsight offers documentation for different REST APIs to load data into the Gainsight Standard objects Company, Person Object model, and any custom objects that you create in Gainsight. As different Gainsight applications are built on these objects, loading data directly into these objects from external systems using APIs enables you to see this data in the Gainsight applications directly.

The following are the synchronous REST APIs available:

  • Company Object API: It helps you understand different APIs to Upsert (Insert and Update) company records into the Gainsight standard object Company. For more information, refer to the Company API Documentation article mentioned in the Additional Resources section.
  • Person API: It helps you understand different APIs to upsert person records into the Gainsight Person object model. For more information, refer to the Person API Documentation article mentioned in the Additional Resources section.
  • Custom Object API: It helps you understand different APIs to upsert records into any Custom object created in Gainsight. For more information, refer to the Custom Object API Documentation article mentioned in the Additional Resources section.
  • Call To Action (CTA) API: It helps you understand different REST APIs that can be used to create and update CTAs, fetch CTAs details, and get CTA configurations. For more information, refer to the Call To Action (CTA) API Documentation article mentioned in the Additional Resources section.
  • Task and Playbook API: It helps you understand different REST APIs that can be used to create and update tasks, and also fetch tasks and playbooks details. For more information, refer to the Task and Playbook API Documentation article mentioned in the Additional Resources section.
  • Success Plan API: These REST APIs can be used to create, update,  fetch Success Plans, and get Success Plan configurations. For more information, refer to the Success Plan API article mentioned in the Additional Resources section.
  • Data Management API: These REST APIs can be used to get Gainsight Object and field details. For more information, refer to the Data Management APIs article mentioned in the Additional Resources section.

Gainsight Bulk API

Bulk API (Asynchronous API Calls) is a Gainsight connector that helps you automate insert or update of large amounts of data from a CSV file into Gainsight standard and custom objects. To insert or update records using this connector, Admins create a Data Ingest Job and perform job configuration like field mappings and derived mappings. As per the job configuration, Admins can generate a cURL API in the connector and share with developers. Developers can then use these APIs to upsert records in various Gainsight objects from external systems. As different Gainsight applications are built on these objects, loading data directly into these objects from external systems helps to see this data in the Gainsight applications directly. Since each job configuration, such as source object, field mappings, derived mappings, etc. are completely controlled by the Gainsight Admin, developers should contact their Gainsight Admin to generate a cURL API that meets a specific requirement.

Data can be loaded into following objects using Gainsight Bulk API:

  • Company
  • Relationship
  • Gainsight Custom objects

For more information on Gainsight Bulk API, refer to the Gainsight Bulk API and Gainsight Bulk API FAQs articles mentioned in the Additional Resources section.

Gainsight API Limits

The following are the recommended API limits for Gainsight APIs (The exact limits can vary based on your package):

  • Synchronous API Calls: 100 API calls per min / 50,000 API call per day
  • Asynchronous API Calls (Gainsight bulk APIs limit): 10 calls per hour / 100 per day

Note: All of the above API limits are *Fixed window rate limits.

* Fixed window rate limiting restricts the number of API requests at a specific time. For example, a server can have a rate limiting component that implements a fixed window algorithm that only accepts 100 requests per minute. The time-frame is fixed, and it starts at a specific time. For example, the server will only serve 100 requests between 10:00 am, and 10:01 am.

  • Was this article helpful?