The Gainsight endpoint returns the GainsightPX configuration and identity data for the current user, so a client can decide whether to load GainsightPX and how to identify the user to it.

The response is driven by a server-side feature flag and the user's account eligibility:

• Disabled — when the Gainsight.IsGainsightEnabled server config flag is off, the account is a FedRamp account, or the account has no valid Ideagen Account ID (IAID), only isGainsightEnabled: false is returned.
• Enabled — when the feature is on and the account is eligible, the full identity payload (PX tag, hashed email, account/plan identifiers) is returned.

The endpoint also inspects the X-Client-App request header to return the GainsightPX tag appropriate to the calling client (web, mobile, or desktop). See Client type resolution.

Note: This endpoint is served by the legacy trunk REST API and is mounted under /rest. It is scoped to the authenticated caller — there are no path or query parameters.

Returns the GainsightPX configuration for the authenticated user. Requires a valid authorization token; the user is taken from the security context (no user identifier is passed in the request).

The GainsightPX tag returned depends on the X-Client-App header (see Client type resolution). All other fields are derived from the user's eligible account.

GET /rest/gainsight HTTP/1.1
Accept: application/vnd.huddle.data+json
X-Client-App: huddle-iphone-app
Authorization: Bearer frootymcnooty/vonbootycherooty

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json

{
  "isGainsightEnabled": true,
  "gainsightPXTag": "AP-XXXXXXXXXXXX-2",
  "emailAddress": "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8",
  "userLicenseType": "Enterprise",
  "userRole": "WorkspaceManager",
  "salesforceAccountId": "0011234567|PLAN_GOLD|SKU-HUDDLE-01",
  "accountName": "Acme Corporation",
  "parentGroupId": "0011234567",
  "plan": "PLAN_GOLD",
  "ideagenSku": "SKU-HUDDLE-01",
  "sfdcId": "0011234567"
}

When Gainsight is not enabled for the user, only the flag is returned:

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json

{
  "isGainsightEnabled": false
}

GET /rest/gainsight HTTP/1.1
Accept: application/vnd.huddle.data+xml
X-Client-App: HuddleDesktopPC
Authorization: Bearer frootymcnooty/vonbootycherooty

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+xml

<?xml version="1.0" encoding="utf-8"?>
<Gainsight xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isGainsightEnabled>true</isGainsightEnabled>
  <gainsightPXTag>AP-XXXXXXXXXXXX-3</gainsightPXTag>
  <emailAddress>5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8</emailAddress>
  <userLicenseType>Enterprise</userLicenseType>
  <userRole>WorkspaceManager</userRole>
  <salesforceAccountId>0011234567|PLAN_GOLD|SKU-HUDDLE-01</salesforceAccountId>
  <accountName>Acme Corporation</accountName>
  <parentGroupId>0011234567</parentGroupId>
  <plan>PLAN_GOLD</plan>
  <ideagenSku>SKU-HUDDLE-01</ideagenSku>
  <sfdcId>0011234567</sfdcId>
</Gainsight>

When Gainsight is not enabled, only the flag element is returned:

<?xml version="1.0" encoding="utf-8"?>
<Gainsight xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isGainsightEnabled>false</isGainsightEnabled>
</Gainsight>

IAID format: salesforceAccountId must contain at least three |-separated segments, each at least two characters long, otherwise the account is treated as ineligible and isGainsightEnabled: false is returned.

• Account Settings — account-level feature configuration.
• Authentication — obtaining an authorization token.