Gainsight CTA Configuration API

Retrieve CTA type and reason configurations

Operations 4

GET /ctas/config/types Gainsight Get CTA types #
GET /ctas/config/reasons Gainsight Get CTA reasons #
GET /ctas/config/priorities Gainsight Get CTA priorities #
GET /ctas/config/statuses Gainsight Get CTA statuses #

Documentation

📖
Documentation
https://support.gainsight.com/PX/API_for_Developers
📖
Authentication
https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
📖
Documentation
https://support.gainsight.com/PX/API_for_Developers/APIs_for_Developers/PX_API
📖
Documentation
https://gainsightpx.docs.apiary.io/
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation
📖
Authentication
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Generate_REST_API/Generate_REST_API_Key
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Custom_Object_API/Gainsight_Custom_Object_API_Documentation
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_(CTA)_API_Documentation
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Timeline_API/Timeline_APIs
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Success_Plan_APIs/Success_Plan_APIs
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Data_Management_APIs/Data_Management_APIs
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_REST_APIs
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_API
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Events_API/Events_API
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/User_Management_APIs
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/SCIM_API
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/API_for_Company_Team_Record
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Customer_Goals_API/Customer_Goals_APIs
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Renewal_Center_API/Renewal_Center_API
📖
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs

Specifications

Other Resources

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-cta-configuration-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.

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

OpenAPI Specification

gainsight-cta-configuration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gainsight CS CTA CTA Configuration API
  description: The Call To Action (CTA) API enables creating and updating CTAs, fetching CTA details, and retrieving CTA configurations through Cockpit REST APIs for managing customer success actions.
  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: CTA Configuration
  description: Retrieve CTA type and reason configurations
paths:
  /ctas/config/types:
    get:
      operationId: getCTATypes
      summary: Gainsight Get CTA types
      description: Retrieve the list of configured CTA types.
      tags:
      - CTA Configuration
      responses:
        '200':
          description: CTA types returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CTAType'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /ctas/config/reasons:
    get:
      operationId: getCTAReasons
      summary: Gainsight Get CTA reasons
      description: Retrieve the list of configured CTA reasons.
      tags:
      - CTA Configuration
      parameters:
      - name: typeId
        in: query
        description: Filter reasons by CTA type ID
        schema:
          type: string
      responses:
        '200':
          description: CTA reasons returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CTAReason'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /ctas/config/priorities:
    get:
      operationId: getCTAPriorities
      summary: Gainsight Get CTA priorities
      description: Retrieve the list of configured CTA priorities.
      tags:
      - CTA Configuration
      responses:
        '200':
          description: CTA priorities returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CTAPriority'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /ctas/config/statuses:
    get:
      operationId: getCTAStatuses
      summary: Gainsight Get CTA statuses
      description: Retrieve the list of configured CTA statuses.
      tags:
      - CTA Configuration
      responses:
        '200':
          description: CTA statuses returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CTAStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CTAType:
      type: object
      properties:
        id:
          type: string
          description: Type identifier
        name:
          type: string
          description: Type name
        isDefault:
          type: boolean
          description: Whether this is the default type
    CTAReason:
      type: object
      properties:
        id:
          type: string
          description: Reason identifier
        name:
          type: string
          description: Reason name
        typeId:
          type: string
          description: Associated CTA type ID
    CTAStatus:
      type: object
      properties:
        id:
          type: string
          description: Status identifier
        name:
          type: string
          description: Status name
        isClosed:
          type: boolean
          description: Whether this status represents a closed state
    CTAPriority:
      type: object
      properties:
        id:
          type: string
          description: Priority identifier
        name:
          type: string
          description: Priority name
        order:
          type: integer
          description: Display order
  responses:
    Unauthorized:
      description: Authentication failed or access key is missing
  securitySchemes:
    apiKey:
      type: apiKey
      name: accessKey
      in: header
      description: Gainsight CS REST API access key
externalDocs:
  description: CTA API Documentation
  url: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_(CTA)_API_Documentation