Gainsight People API

Manage person records

Documentation GitHub OpenAPI

Business capability

Operations 5

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 /data/objects/Person Upsert person records · Gainsight Upsert person records #

Ask an LLM

“How do I create or update contacts in Gainsight matched on email?”

“How many person records can I upsert per call?”

Tell an agent

Upsert these person records matched on {keys}: {records}.

Insert or update contacts {records} using key fields {keys}.

POST /data/objects/Person/search Search person records · Gainsight Search person records #

Ask an LLM

“Which contacts work at a given company?”

“Can I query people with filters and up to 5000 results?”

Tell an agent

Search person records where {where}.

Find people matching {where}, ordered by {orderBy}.

GET /data/objects/Person/{recordId} Get a person record · Gainsight Get a person record #

Ask an LLM

“How do I read one contact's record by Gainsight ID?”

“Can I fetch a person by GSID?”

Tell an agent

Get person {recordId}.

Show the contact record {recordId}.

DELETE /data/objects/Person/{recordId} Delete a person record · Gainsight Delete a person record #

Ask an LLM

“Can I delete a contact from Gainsight?”

“How is a person record removed by GSID?”

Tell an agent destructive · confirm first

Delete person {recordId}.

Remove contact {recordId} from Gainsight.

GET /v1/people List person records · Gainsight List people #

Ask an LLM

“What contacts are stored in Gainsight?”

“Can I page through all people with page numbers?”

Tell an agent

List people, page {pageNumber}.

Show all person records, {pageSize} per page.

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:gainsight-people-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Gainsight People API
  version: '1.0'
  contact:
    name: Gainsight Support
    url: https://support.gainsight.com
    email: support@gainsight.com
  termsOfService: https://www.gainsight.com/terms-of-service/
  description: 'Operations tagged People across 2 of this provider''s published API definitions: gainsight-cs-person-api-openapi.yml, gainsight-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domain}.gainsightcloud.com/v1
  description: Gainsight CS Production
  variables:
    domain:
      default: customer
      description: Customer-specific domain prefix
- url: https://api.gainsight.com
  description: Gainsight Production API
security:
- apiKey: []
tags:
- name: People
  description: Manage person records
paths:
  /data/objects/Person:
    post:
      operationId: upsertPeople
      summary: Gainsight Upsert person records
      description: Insert or update person records in Gainsight. Supports up to 50 records per call with upsert behavior based on key fields.
      tags:
      - People
      parameters:
      - name: keys
        in: query
        required: true
        description: Comma-separated key fields for matching (e.g., Email)
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - records
              properties:
                records:
                  type: array
                  maxItems: 50
                  items:
                    $ref: '#/components/schemas/PersonRecord'
      responses:
        '200':
          description: Records upserted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WriteResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://{domain}.gainsightcloud.com/v1
      description: Gainsight CS Production
      variables:
        domain:
          default: customer
          description: Customer-specific domain prefix
  /data/objects/Person/search:
    post:
      operationId: searchPeople
      summary: Gainsight Search person records
      description: Search for person records using filter criteria. Returns up to 5000 records per call.
      tags:
      - People
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Search results returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: object
                    properties:
                      records:
                        type: array
                        items:
                          $ref: '#/components/schemas/PersonRecord'
                      totalCount:
                        type: integer
                      count:
                        type: integer
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://{domain}.gainsightcloud.com/v1
      description: Gainsight CS Production
      variables:
        domain:
          default: customer
          description: Customer-specific domain prefix
  /data/objects/Person/{recordId}:
    get:
      operationId: getPerson
      summary: Gainsight Get a person record
      description: Retrieve a specific person record by Gainsight ID.
      tags:
      - People
      parameters:
      - $ref: '#/components/parameters/recordId'
      responses:
        '200':
          description: Person record returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/PersonRecord'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deletePerson
      summary: Gainsight Delete a person record
      description: Delete a person record by Gainsight ID.
      tags:
      - People
      parameters:
      - $ref: '#/components/parameters/recordId'
      responses:
        '200':
          description: Record deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://{domain}.gainsightcloud.com/v1
      description: Gainsight CS Production
      variables:
        domain:
          default: customer
          description: Customer-specific domain prefix
  /v1/people:
    get:
      operationId: listPeople
      summary: Gainsight List people
      description: Retrieve a list of person records from Gainsight.
      tags:
      - People
      parameters:
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: List of people returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: object
                    properties:
                      records:
                        type: array
                        items:
                          $ref: '#/components/schemas/Person'
                      totalCount:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://api.gainsight.com
      description: Gainsight Production API
components:
  responses:
    NotFound:
      description: The requested resource was not found
    BadRequest:
      description: Invalid request body or parameters
    Unauthorized:
      description: Authentication failed or access key is missing
  schemas:
    ApiResponse:
      type: object
      properties:
        result:
          type: boolean
        errorCode:
          type: string
        errorDesc:
          type: string
        requestId:
          type: string
    PersonRecord:
      type: object
      properties:
        Gsid:
          type: string
          description: Gainsight unique identifier
        FirstName:
          type: string
          description: First name
        LastName:
          type: string
          description: Last name
        Email:
          type: string
          format: email
          description: Email address
        CompanyId:
          type: string
          description: Associated company Gsid
        CompanyName:
          type: string
          description: Associated company name
        Title:
          type: string
          description: Job title
        Role:
          type: string
          description: Contact role
        Phone:
          type: string
          description: Phone number
        Location:
          type: string
          description: Location
        LinkedinUrl:
          type: string
          format: uri
          description: LinkedIn profile URL
        MasterAvatarTypeCode:
          type: string
          description: Avatar type code
        Timezone:
          type: string
          description: Timezone
        SfdcContactId:
          type: string
          description: Salesforce contact ID
        NPS:
          type: number
          description: Net promoter score
        IsPrimary:
          type: boolean
          description: Whether this is the primary contact
        IsActive:
          type: boolean
          description: Whether the person is active
        CreatedDate:
          type: string
          format: date-time
          description: Record creation timestamp
        ModifiedDate:
          type: string
          format: date-time
          description: Last modification timestamp
    SearchRequest:
      type: object
      properties:
        select:
          type: array
          items:
            type: string
        where:
          type: object
          properties:
            conditions:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  alias:
                    type: string
                  value: {}
                  operator:
                    type: string
                    enum:
                    - EQ
                    - NE
                    - GT
                    - GTE
                    - LT
                    - LTE
                    - CONTAINS
                    - STARTS_WITH
                    - ENDS_WITH
                    - IN
                    - NOT_IN
            expression:
              type: string
        orderBy:
          type: object
          properties:
            field:
              type: string
            order:
              type: string
              enum:
              - ASC
              - DESC
        limit:
          type: integer
          maximum: 5000
        offset:
          type: integer
    WriteResponse:
      type: object
      properties:
        result:
          type: boolean
        data:
          type: object
          properties:
            count:
              type: integer
            insertedCount:
              type: integer
            updatedCount:
              type: integer
            failedCount:
              type: integer
            failures:
              type: array
              items:
                type: object
                properties:
                  index:
                    type: integer
                  errorMessage:
                    type: string
    Person:
      type: object
      properties:
        Gsid:
          type: string
          description: Gainsight unique identifier
        FirstName:
          type: string
          description: First name
        LastName:
          type: string
          description: Last name
        Email:
          type: string
          format: email
          description: Email address
        CompanyId:
          type: string
          description: Associated company ID
        Role:
          type: string
          description: Role or title
        Location:
          type: string
          description: Location
        CreatedDate:
          type: string
          format: date-time
          description: Record creation timestamp
        ModifiedDate:
          type: string
          format: date-time
          description: Record last modified timestamp
  parameters:
    recordId:
      name: recordId
      in: path
      required: true
      description: Gainsight record unique identifier (Gsid)
      schema:
        type: string
    pageSize:
      name: pageSize
      in: query
      description: Number of records per page
      schema:
        type: integer
        default: 25
        maximum: 100
    pageNumber:
      name: pageNumber
      in: query
      description: Page number for pagination
      schema:
        type: integer
        default: 0
  securitySchemes:
    apiKey:
      type: apiKey
      name: accessKey
      in: header
      description: Gainsight CS REST API access key
x-refined-from:
- gainsight-cs-person-api-openapi.yml
- gainsight-rest-api-openapi.yml

Gainsight People API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification