Gainsight Fields API

openapi: 3.1.0
info:
  title: Gainsight CS Bulk Accounts Fields API
  description: The Gainsight Bulk API is an asynchronous connector that automates insert or update of large data volumes from CSV files into Gainsight standard and custom objects, with rate limits of 10 calls per hour and 100 per day.
  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:
  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
  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
  securitySchemes:
    apiKey:
      type: apiKey
      name: accessKey
      in: header
      description: Gainsight CS REST API access key
externalDocs:
  description: Bulk API Documentation
  url: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_REST_APIs