Gainsight

Gainsight User Preferences API

User Preferences

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/user/preferences Read preferences for a user ID in the body · Get user preferences (identifyId passed via request body) #
Ask an LLM
“How do I read a user's preferences when their ID can't go in the URL?”
“Is there a POST lookup for user preferences?”
Tell an agent
Look up preferences for user {identifyId}, passing the ID in the body.
Fetch the opt-in settings of body-identified user {identifyId}.
PUT /v1/user/preferences Update preferences for a user ID in the body · Update user preferences (identifyId passed via request body) #
Ask an LLM
“My user's identify ID has special characters, so how can I update their preferences?”
“Can I opt a user out of surveys by passing their ID in the request body?”
Tell an agent
Update preferences for user {identifyId} (ID in body): surveys {surveys}.
Turn guided tours {guidedTours} for body-identified user {identifyId}.
GET /v1/user/preferences/{identifyId} Get a user's preferences · Get user preferences #
Ask an LLM
“Has a user opted out of usage tracking or product updates?”
“What communication preferences does a user have set?”
Tell an agent
Get the preferences of user {identifyId}.
Show whether user {identifyId} allows surveys and guided tours.
PUT /v1/user/preferences/{identifyId} Update a user's preferences · Update user preferences #
Ask an LLM
“How do I stop tracking usage for a user who opted out?”
“Can I change only one preference and leave the others?”
Tell an agent
Set track usage to {trackUsage} for user {identifyId}.
Update user {identifyId}: product updates {productUpdates}, onboarding bot {onboardingBot}.

Documentation

📖
APIReference
https://px-apidocs.gainsight.com/
📖
Documentation
https://support.gainsight.com/PX/API_for_Developers
📖
Authentication
https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/rate-limits/gainsight-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/openapi/gainsight-user-preferences-api-openapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/llms/gainsight-px-llms.txt
🔗
API Keys
https://support.gainsight.com/PX/API_for_Developers/02About/API_Keys
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/data-model/gainsight-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/errors/gainsight-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gainsight-user-preferences-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gainsight-user-preferences-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Gainsight PX API provides a programmatic (server-based) method to access the users, accounts, and events that have been captured by the Gainsight PX subscription.
  version: 0.1.6
  title: Gainsight PX REST User Preferences API
  contact:
    name: Gainsight PX
    url: https://www.gainsight.com/product-experience/
    email: pxsupport@gainsight.com
  license:
    name: internal
servers:
- url: https://api.aptrinsic.com/
tags:
- name: User Preferences
  description: User Preferences
paths:
  /v1/user/preferences:
    post:
      tags:
      - User Preferences
      summary: Get user preferences (identifyId passed via request body)
      description: If the field is not set - return null.
      operationId: getUserPreferencesUsingPOST
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserPreferences'
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIdentifyId'
        description: User identify id
        required: true
    put:
      tags:
      - User Preferences
      summary: Update user preferences (identifyId passed via request body)
      description: 'The fields are optional so it’s possible to provide only those that need to be updated.


        If the user had preferences - override only the provided fields.


        Valid field values: true, false, null.


        Note: null value won’t override any other.'
      operationId: updateUserPreferencesUsingPUT_1
      responses:
        '204':
          description: Updated
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserPreferences'
        description: User preferences
        required: true
  /v1/user/preferences/{identifyId}:
    get:
      tags:
      - User Preferences
      summary: Get user preferences
      description: If the field is not set - return null.
      operationId: getUserPreferencesUsingGET
      parameters:
      - name: identifyId
        in: path
        description: User identify id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserPreferences'
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
    put:
      tags:
      - User Preferences
      summary: Update user preferences
      description: 'The fields are optional so it’s possible to provide only those that need to be updated.


        If the user had preferences - override only the provided fields.


        Valid field values: true, false, null.


        Note: null value won’t override any other.'
      operationId: updateUserPreferencesUsingPUT
      parameters:
      - name: identifyId
        in: path
        description: User identify id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Updated
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPreferences'
        description: User preferences
        required: true
components:
  schemas:
    UserIdentifyId:
      type: object
      required:
      - identifyId
      properties:
        identifyId:
          type: string
      title: UserIdentifyId
      description: User object
    UpdateUserPreferences:
      type: object
      required:
      - identifyId
      properties:
        guidedTours:
          type: boolean
        identifyId:
          type: string
          readOnly: true
        onboardingBot:
          type: boolean
        productUpdates:
          type: boolean
        surveys:
          type: boolean
        trackUsage:
          type: boolean
      title: UpdateUserPreferences
      description: Update user preferences
    UserPreferences:
      type: object
      properties:
        guidedTours:
          type: boolean
        onboardingBot:
          type: boolean
        productUpdates:
          type: boolean
        surveys:
          type: boolean
        trackUsage:
          type: boolean
      title: UserPreferences
      description: User preferences
  securitySchemes:
    X-APTRINSIC-API-KEY:
      type: apiKey
      name: Aptrinsic API Key
      in: header