Get user preferences. This version of API includes extra property 'trackEmailAnalytics' in the response.

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://px-apidocs.gainsight.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "gainsight-px-rest-api MCP server": {
    "url": "https://px-apidocs.gainsight.com/mcp"
  }
}

Close
GET /v2/user/preferences/{identifyId}

If the field is not set - return null.

Path parameters

  • identifyId string Required

    User identify id

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • guidedTours boolean
    • onboardingBot boolean
    • productUpdates boolean
    • surveys boolean
    • trackEmailAnalytics boolean
    • trackUsage boolean
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 403

    Access denied

  • 404

    User not found by id

  • 429

    Rate limit exceeded

GET /v2/user/preferences/{identifyId}
curl \
 --request GET 'https://api.aptrinsic.com/v2/user/preferences/{identifyId}'
Response examples (200)
{
  "guidedTours": true,
  "onboardingBot": true,
  "productUpdates": true,
  "surveys": true,
  "trackEmailAnalytics": true,
  "trackUsage": true
}