Connectors
Customer Support & Success
Gainsight
Customer success: accounts, health scores, CTAs, timelines, and surveys
Gainsight API referenceAPI checked August 17, 2026
- Signs in with
- Connection fields
- Runs on
- Cloud or On-Prem Worker
- Operations
- 111
- Ready-made triggers
- 0
Connect Gainsight
- In Neblex open Connect › Connections and click New Connection.
- Search for Gainsight and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| TenanthostRequired | Your exact Gainsight NXT tenant host. |
| TokenOptionalSecret | Legacy Gainsight access key. |
| Access TokenOptionalSecret | OAuth or M2M Bearer access token. |
| Client IdOptionalSecret | M2M OAuth client ID. |
| Client SecretOptionalSecret | M2M OAuth client secret. |
| Event Shared SecretOptionalSecret | Events Framework publisher shared secret. |
Use it in a flow
- Open a flow, open the node library and search for Gainsight.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Gainsight without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Gainsight can send webhooks, a Webhook trigger receives them at its own URL.
Operations
111 operations in 20 groups. Each one is a step you can add to a flow.
Bulk Rest3
Bulk Job StatusbulkexportBulkJobStatus | GET | This API can be used to check the job status of the Bulk API. |
Fetch Chunk DatabulkexportFetchChunkData | GET | This API can be used to download large amounts of data in chunks (multiple files). |
Submit Bulk Job RequestbulkexportSubmitBulkJobRequest | POST | This API can be used to submit the bulk job request to download the data from Gainsight custom object. |
Cockpit Deleted Data4
Cta DeletedcockpitCTADeleted | POST | CTA Endpoint URL Endpoint One: /v2/cockpit/cta/deleted/list Endpoint Two: /v2/cockpit/cta/list (against this endpoint send "includeonlyDeletedRecords":true as part of Body) Method Post... |
Cta Include Only DeletedcockpitCTAIncludeOnlyDeleted | POST | CTA Endpoint URL Endpoint One: /v2/cockpit/cta/deleted/list Endpoint Two: /v2/cockpit/cta/list (against this endpoint send "includeonlyDeletedRecords":true as part of Body) Method Post... |
Task DeletedcockpitTaskDeleted | POST | Task Endpoint URL Endpoint One: /v2/cockpit/task/deleted/list Endpoint Two: /v2/cockpit/task/list (against this endpoint send "includeonlyDeletedRecords":true as part of Body) Method Post... |
Task Include Only DeletedcockpitTaskIncludeOnlyDeleted | POST | Task Endpoint URL Endpoint One: /v2/cockpit/task/deleted/list Endpoint Two: /v2/cockpit/task/list (against this endpoint send "includeonlyDeletedRecords":true as part of Body) Method Post... |
Company4
DeletedeleteCompany | DELETE | Delete API deletes a specific record in the Company object. |
InsertinsertCompanies | POST | The Insert API is used to insert one or more records into the Gainsight’s Company object. |
ReadqueryCompanies | POST | Read API allows you to read one or more records that match a specific criteria from the Company object. |
UpdateupdateCompanies | PUT | Update API is used to update one or more existing records in the Company object. |
Company Team4
Bulk Delete Company Teams RecordscompanyteamBulkDeleteCompanyTeamsRecords | POST | The Bulk Delete REST API of the Company Teams record allows the deletion of company team records in bulk within Gainsight. |
Delete Company Teams RecordscompanyteamDeleteCompanyTeamsRecords | DELETE | The Delete REST API of the Company Teams record allows the deletion of company team records within Gainsight. |
Fetch Company Teams RecordscompanyteamFetchCompanyTeamsRecords | POST | The Fetch API allows to retrieve specific details of company teams stored in Gainsight. |
Upsert Company Teams RecordscompanyteamUpsertCompanyTeamsRecords | PUT | The Upsert API serves a dual purpose. |
Copilot1
Chat SynccopilotChatSync | POST | The Chat Sync API is the only endpoint exposed for Copilot as an External API. |
Cta4
Create CtactaCreateCTA | POST | Create CTA API is used to create a new CTA in Gainsight. |
Fetch CtactaFetchCTA | POST | Fetch CTA API is used to fetch CTAs in Gainsight. |
Get Cta Configuration GetcockpitconfigctaGetCTAConfigurationGetCockpitConfig | GET | Get CTA Configuration API is used to get the CTA Configuration for the CTA Type, Reason, Status, and Priority. |
Update CtactaUpdateCTA | PUT | Update CTA API is used to update existing CTAs in Gainsight. |
Custom Objects4
DeletedeleteCustomObjectRecord | DELETE | Delete API deletes a specific record in a custom object. |
InsertinsertCustomObjectRecords | POST | Insert API is used to insert one or more records into the Gainsight custom object. |
ReadqueryCustomObjectRecords | POST | The Read API allows you to read one or more records that match a specific criteria from the Gainsight custom object. |
UpdateupdateCustomObjectRecords | PUT | The Update API is used to update one or more existing records in a custom object. |
Customer Goals11
Get PicklistcustomergoalGETPicklist | GET | GET Picklist Method Endpoint URL /v1/csgoal/external/admin/picklist Sample Request Body { "entityIds": ["COMPANY"], // Pass COMAPANY, RELATIONSHIP TYPE IDs, ALL ENTITY or any cobination... |
Goal CreatecustomergoalGoalCreate | POST | Goal Create API Method POST Endpoint URL POST /v1/csgoal/external/create Sample Request Body { "requests": [ { "record": { "Name": "Custom Goal 1", // Pass Name of the goal "GoalTypeId":... |
Goal FetchcustomergoalGoalFetch | POST | Goal Fetch API Method POST Endpoint URL POST /v1/csgoal/external/fetch Sample Request Body { "select": [ "Name", "Gsid", "StatusId", "cust string value gc", "CurrencyIsoCode" ], "where":... |
Goal Update GoalcustomergoalGoalUpdateGoal | PUT | Goal Update Goal Method PUT Endpoint URL PUT /v1/csgoal/external/update Sample Request Body { "requests": [ { "record": { "Gsid": "1CG0LXVS2HO4Y5ZF1F6TV4R7ZV0ZO6MPG6S1", // GSID of... |
Metric CreatecustomergoalMetricCreate | POST | Metric Create API Method POST Endpoint URL POST /csgoal/external/metric/ Sample Request Body { "requests": [ { "record": { "name": "Metric Name 1", // Metric name "unitOfMeasure":... |
Metric DeletecustomergoalMetricDelete | DELETE | Metric Delete API Method DELETE Endpoint URL DELETE /csgoal/external/metrics Sample Request Body { "recordIds": ["1I0056K976K5AXWOB1NB0L2GCSS77AMROJ8W"] // GSID of the metric to be... |
Metric UpdatecustomergoalMetricUpdate | PUT | Metric Update API Method PUT Endpoint URL PUT /csgoal/external/metric/ Sample Request Body { "requests": [ { "record": { "gsid": "1I0056K976K5AXWOB1PGJTG9R7V2KYR0KBHZ", // GSID of... |
Template CreatecustomergoalTemplateCreate | POST | Template Create API Method CREATE Endpoint URL POST /v1/csgoal/external/template Sample Request Body { "requests": [ { "record": { "Name": "Goal Template 1", // Name of the goal template... |
Template DeletecustomergoalTemplateDelete | DELETE | Template Delete API Method Delete Endpoint URL /v1/csgoal/external/template/delete Sample Request Body { "recordIds": ["1CG01SX5TCMHZ0OXX0750YQUGDZ3WPZ50KBY"] // GSID of Goal Template to... |
Template FetchcustomergoalTemplateFetch | POST | Template Fetch API Method POST Endpoint URL /v1/csgoal/external/template/fetch Sample Request Body { "select": [ // Fields whose data needs to be fetched "Name", "Gsid", "StatusId", "cust... |
Template UpdatecustomergoalTemplateUpdate | PUT | Template Update API Method PUT Endpoint URL Put /v1/csgoal/external/template Sample Request Body { "requests": [ { "record": { "Gsid": "1CG01SX5TCMHZ0OXX0XMV01B68HZR4B6W7AX", // Name of... |
Data Management8
Get CategoryidmetadataGetCategoryID | GET | Get API - categoryID Method GET Endpoint URL /v1/meta/services/dropdowns/{categoryId} Sample Request '{host}/v1/meta/services/dropdowns/{categoryId}' 'authToken: {authToken}' Sample... |
Get Describe OmddescribeObject | GET | This API fetches the Object details and the related Object details such as ObjectName, label, objectType, labelPlural, and keyPrefix. |
Get Lite Call OmdmetadataGetLiteCallOMD | GET | This API is used to fetch the list of Objects with the minimum metadata information such as: |
Post Describe OmdmetadataPostDescribeOMD | POST | This API is used to fetch the specific Objects detail and related Objects detail by filtering the response. |
Post Dropdown DependenciesmetadataPostDropdownDependencies | POST | Post API - Dropdown Dependencies Method POST Endpoint URL /v1/meta/services/dropdowns/dependencies Sample Request '{host}/v1/meta/services/dropdowns/dependencies' 'authToken: {authToken}'... |
Post Lite Call OmdmetadataPostLiteCallOMD | POST | This API is used to fetch the specific list of Objects with the minimum metadata information by filtering the required Objects. |
Retrieve Deleted Data High VolumemetadataRetrieveDeletedDataHighVolume | POST | This API helps to retrieve deleted data and improve backup strategies, allowing admins to restore data more efficiently and less resource-intensive. |
Retrieve Deleted Data Low VolumemetadataRetrieveDeletedDataLowVolume | POST | This API helps to retrieve deleted data and improve backup strategies, allowing admins to restore data more efficiently and less resource-intensive. |
Events1
Publish An EventeventPublishAnEvent | POST | The Publish an Event API is an external API which helps you to publish an event in the Gainsight. |
Oauth4
Exchange Oauth Authorization Code Authorization CodeoauthExchangeOAuthAuthorizationCodeAuthorizationCode | POST | The following are the major steps to configure OAuth for accessing Gainsight APIs: |
Exchange Oauth Authorization Code Earlier Version EarlieroauthExchangeOAuthAuthorizationCodeEarlierVersionEarlier | POST | The following are the major steps to configure OAuth for accessing Gainsight APIs: |
Refresh Oauth Access Token Refresh TokenoauthRefreshOAuthAccessTokenRefreshToken | POST | After an Access Token expires, you can get a new Access Token by using the Refresh Token generated with the Access Token. |
Revoke Oauth Refresh Token RevokeoauthRevokeOAuthRefreshTokenRevoke | POST | Admins can revoke the Refresh Token by calling the APIs. |
People15
DeletepeopleDelete | DELETE | Person Delete API can be used to delete Person record(s) from Gainsight. |
Get Delete StatuspeopleGETDeleteStatus | GET | This API helps you get the current status of the delete request submitted through Delete API. |
Get Person With EmailpeopleGetPersonWithEmail | GET | Get API allows you to get one record per API call from the Person, Company Person, and Relationship Person objects associated with a Person GSID passed in the Endpoint URL. |
Get Person With GsidpeopleGetPersonWithGSID | GET | Get API allows you to get one record per API call from the Person, Company Person, and Relationship Person objects associated with a Person GSID passed in the Endpoint URL. |
People S Bulk Async ProcesspeoplePeopleSBulkAsyncProcess | POST | This API is required to load data into People Module using a JSON File. |
People S Bulk Async Process Chunk ResultpeoplePeopleSBulkAsyncProcessChunkResult | GET | This API helps to download the chunk file that is retrieved by the People APIs - Bulk Async Process Status API. |
People S Bulk Async Process StatuspeoplePeopleSBulkAsyncProcessStatus | GET | The People APIs - Bulk Async Process Status API helps to fetch detailed information on the status and can also retrieve the chunk file. |
People Upsert Record RequestpeoplePeopleUpsertRecordRequest | PUT | This API is required to load data into Person, CompanyPerson, and RelationshipPerson associations. |
People Upsert Record Request With Lookup DetailspeoplePeopleUpsertRecordRequestWithLookupDetails | PUT | This API upserts the person, companies, and relationships associations after resolving the given lookup details. |
Upsert Async Person With Association Ids Or Lookup DetailspeopleUpsertAsyncPersonWithAssociationIDsOrLookupDetails | PUT | The Upsert API is used to insert or update multiple records per API call into the Person object. |
Upsert PersonpeopleUpsertPerson | PUT | This Upsert API is used to insert or upsert a record into the Person object which is not associated with any Company or Relationship. |
Upsert PersonpeopleUpsertPerson2 | PUT | This Upsert API is used to insert or update multiple records into the Person object that are not associated with any Company or Relationship. |
Upsert Person With Association Ids Or Lookup DetailspeopleUpsertPersonWithAssociationIDsOrLookupDetails | PUT | This Upsert API is used to insert or update one record per API call into the Gainsight Person model and this record can have multiple associations with one or multiple Companies and... |
Upsert StatuspeopleUpsertStatus | GET | This API is used to obtain the processing status of the person record request that has been passed through any of the Async Upsert APIs. |
Upsert With Only Company And Relationship LookuppeopleUpsertWithOnlyCompanyAndRelationshipLookup | PUT | This Upsert API is used to insert multiple records per API call into the Company Person and Relationship Person objects that are tied to a unique record in the Person object. |
Relationship6
Create Relationship SrelationshipCreateRelationshipS | POST | This API can be used to create Relationships in Gainsight using Company Id and Type Id. |
Create Relationship S Using LookupsrelationshipCreateRelationshipSUsingLookups | POST | If the customer doesn’t have the CompanyID or TypeID they could still create relationships using Lookups. |
Delete Relationship SrelationshipDeleteRelationshipS | DELETE | This API can be used to delete a Relationship using GSID. |
Update Relationship Record SrelationshipUpdateRelationshipRecordS | PUT | This API can be used for updating the Relationship fields by using identifiers. |
Upsert Relationship Record SrelationshipUpsertRelationshipRecordS | PUT | This API can be used to find the Relationship (using Identifier) and update it. |
View RelationshipsrelationshipViewRelationships | POST | This API can be used to view all the Relationships in your Gainsight instance. |
Renewal Center2
Create OpportunityrenewalCreateOpportunity | POST | This API is used to create a single opportunity record or bulk opportunity records. |
Update OpportunityrenewalUpdateOpportunity | PATCH | This API is used to update a single opportunity record or bulk opportunity records. |
Rest Key2
Active State Of A Tokenm2mActiveStateOfAToken | POST | The Active state of a Token API is used to determine the active state of a token and meta-information about it, such as its expiry information. |
Get Access Tokenm2mGetAccessToken | POST | The Get Access Token API is used to generate an access token that is required to authenticate |
Scim14
Add ValuescimAddValue | PATCH | The Add Value API is used to update specific fields or attributes of a resource by adding or modifying values without affecting the entire resource. |
Inactivate ActivescimInactivateActive | PATCH | The Inactivate/Activate API is used to change the status of a resource, toggling it between inactive and active states. |
Remove ValuescimRemoveValue | PATCH | The Remove Value API is used to delete or remove users from a group. |
Replace ValuescimReplaceValue | PATCH | The Replace Value API is used to update or overwrite an existing value of a specific field or attribute within a resource. |
Scim Add Members To GroupscimSCIMAddMembersToGroup | PATCH | The SCIM Add Members to Group API is used to add users or resources to a specific group within a system. |
Scim Create GroupscimSCIMCreateGroup | POST | The SCIM Create Group API creates a new group in Gainsight. |
Scim Create UserscimSCIMCreateUser | POST | The SCIM Create User API automatically creates a new user in a system by integrating with external identity providers, ensuring streamlined user provisioning. |
Scim GetscimSCIMGET | GET | The SCIM GET API is used to retrieve user or resource information from a system based on SCIM standards. |
Scim Get GroupscimSCIMGetGroup | GET | The SCIM Get Group API is used to retrieve details of a specific group within a system. |
Scim Remove Members From GroupscimSCIMRemoveMembersFromGroup | PATCH | The SCIM Remove Members from Group API removes all existing users from current group and add the users which are giving in the request payload. |
Scim Replace GroupscimSCIMReplaceGroup | PUT | The SCIM Replace Group API replaces the display name of an existing group in Gainsight. |
Scim Replace Member From GroupscimSCIMReplaceMemberFromGroup | PATCH | The SCIM Replace Members from Group API is used to replace users or resources from a specific group within a system. |
Scim Search GroupscimSCIMSearchGroup | GET | The SCIM Search Group API is used to search for and retrieve information about groups within a system based on specified query parameters. |
Scim Search UserscimSCIMSearchUser | GET | The SCIM Search API is used to search for and retrieve multiple users or resources based on specified query parameters in a system. |
Success Plans7
Create Success Plan With ObjectivessuccessplanCreateSuccessPlanWithObjectives | POST | This API creates a Success Plan with objectives within the same API call without the need to call multiple APIs to create objectives. |
Create Success Plan Without ObjectivessuccessplanCreateSuccessPlanWithoutObjectives | POST | This API allows admins to create a new Success Plan in Gainsight. |
Fetch Success PlansuccessplanFetchSuccessPlan | POST | This API helps fetching the Success Plans data available in your Gainsight org. |
Get Success Plan ConfigurationssuccessplanGetSuccessPlanConfigurations | GET | This API gets the Success Plan Configuration for the Success Plan Type, Status, and Objective Categories. |
Retrieve Deleted Data DeletedsuccessplanRetrieveDeletedDataDeleted | POST | This API helps to retrieve deleted data and improve backup strategies, allowing admins to restore data more efficiently and less resource-intensive. |
Retrieve Deleted Data Include Only DeletedsuccessplanRetrieveDeletedDataIncludeOnlyDeleted | POST | This API helps to retrieve deleted data and improve backup strategies, allowing admins to restore data more efficiently and less resource-intensive. |
Update Success PlansuccessplanUpdateSuccessPlan | PUT | This API updates the existing Success Plans in Gainsight. |
Tasks Playbooks4
Create TasktaskCreateTask | POST | The Create Task API is used to create a new CSTask in Gainsight. |
Fetch Task ListtaskFetchTaskList | GET | The Fetch Task List API is used to fetch the list of Tasks in Gainsight. |
Get Playbook Configuration GetplaybookconfigtaskGetPlaybookConfigurationGetPlaybookConfig | GET | Get Playbook Configuration API is used to get the list of all the Playbook configurations ‘Et’ is used for the entity type for which the picklist configuration should be returned. |
Update TasktaskUpdateTask | PUT | The Update Task API is used to update an existing CSTask in Gainsight. |
Timeline9
AborttimelineAbort | PUT | This API helps you abort the submitted bulk insert/update records job. |
Bulk Activity SavetimelineBulkActivitySave | POST | This API helps you save multiple Activities to Timeline. |
Bulk UpdatetimelineBulkUpdate | PUT | This API updates Activities listed in the request body. |
DeletetimelineDelete | DELETE | This API deletes Activities listed in the request body. |
Fetch DeletedtimelineFetchDeleted | POST | This API helps you retrieve the list of deleted Activities in the given timestamp range. |
Get StatustimelineGetStatus | GET | This API helps you check the status of submitted bulk records. |
ReadtimelineRead | POST | This API lets you read the inserted activity record details. |
Single Activity SavetimelineSingleActivitySave | POST | This API helps you save an Activity to Timeline. |
Single UpdatetimelineSingleUpdate | PUT | This API updates a single activity provided in the request body. |
User Management4
Create UsersuserCreateUsers | POST | This API can be used to create users in Gainsight. |
Fetch User DetailsuserFetchUserDetails | POST | This API can be used to get the details of the users in Gainsight. |
Update UsersuserUpdateUsers | PUT | This API can be used to update user details in Gainsight. |
Update Users StatususerUpdateUsersStatus | PUT | This API can be used to update the status (active/inactive) of the users in Gainsight. |