Gainsight

Gainsight Fields API

Retrieve field metadata

Documentation GitHub OpenAPI

Operations 2

GET /meta/objects/{objectName}/fields Gainsight List fields for an object #

GET /meta/objects/{objectName}/fields/{fieldName} Gainsight Get field metadata #

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-fields-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

openapi: 3.2.0
info:
  title: Gainsight CS Data Management Fields API
  description: The Data Management API provides access to Gainsight object and field metadata, enabling retrieval of schema information for integration and data mapping purposes.
  version: '1.0'
  contact:
    name: Gainsight Support
    url: https://support.gainsight.com
    email: support@gainsight.com
  termsOfService: https://www.gainsight.com/terms-of-service/
servers:
- url: https://{domain}.gainsightcloud.com/v1
  description: Gainsight CS Production
  variables:
    domain:
      default: customer
      description: Customer-specific domain prefix
security:
- apiKey: []
tags:
- name: Fields
  description: Retrieve field metadata
paths:
  /meta/objects/{objectName}/fields:
    get:
      operationId: listFields
      summary: Gainsight List fields for an object
      description: Retrieve field metadata for a specific Gainsight object.
      tags:
      - Fields
      parameters:
      - $ref: '#/components/parameters/objectName'
      responses:
        '200':
          description: Field metadata returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FieldMetadata'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /meta/objects/{objectName}/fields/{fieldName}:
    get:
      operationId: getField
      summary: Gainsight Get field metadata
      description: Retrieve metadata for a specific field on a Gainsight object.
      tags:
      - Fields
      parameters:
      - $ref: '#/components/parameters/objectName'
      - $ref: '#/components/parameters/fieldName'
      responses:
        '200':
          description: Field metadata returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/FieldMetadata'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found
    Unauthorized:
      description: Authentication failed or access key is missing
  schemas:
    FieldMetadata:
      type: object
      properties:
        fieldName:
          type: string
          description: Field API name
        label:
          type: string
          description: Field display label
        description:
          type: string
          description: Field description
        dataType:
          type: string
          enum:
          - STRING
          - NUMBER
          - BOOLEAN
          - DATE
          - DATETIME
          - CURRENCY
          - PERCENTAGE
          - EMAIL
          - URL
          - PHONE
          - PICKLIST
          - MULTI_PICKLIST
          - LOOKUP
          - RICH_TEXT
          description: Field data type
        isRequired:
          type: boolean
          description: Whether the field is required
        isReadOnly:
          type: boolean
          description: Whether the field is read-only
        isCustom:
          type: boolean
          description: Whether this is a custom field
        maxLength:
          type: integer
          description: Maximum length for string fields
        picklistValues:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
          description: Picklist options for picklist fields
        lookupObjectName:
          type: string
          description: Referenced object name for lookup fields
  parameters:
    objectName:
      name: objectName
      in: path
      required: true
      description: Name of the Gainsight object
      schema:
        type: string
    fieldName:
      name: fieldName
      in: path
      required: true
      description: Name of the field
      schema:
        type: string
  securitySchemes:
    apiKey:
      type: apiKey
      name: accessKey
      in: header
      description: Gainsight CS REST API access key
externalDocs:
  description: Data Management API Documentation
  url: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Data_Management_APIs/Data_Management_APIs