Gainsight Playbooks API

openapi: 3.1.0
info:
  title: Gainsight CS Bulk Accounts Playbooks 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: Playbooks
  description: Retrieve playbook configurations
paths:
  /playbooks:
    get:
      operationId: listPlaybooks
      summary: Gainsight List playbooks
      description: Retrieve a list of configured playbooks.
      tags:
      - Playbooks
      responses:
        '200':
          description: Playbooks returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Playbook'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /playbooks/{playbookId}:
    get:
      operationId: getPlaybook
      summary: Gainsight Get a playbook
      description: Retrieve a specific playbook with its task templates.
      tags:
      - Playbooks
      parameters:
      - $ref: '#/components/parameters/playbookId'
      responses:
        '200':
          description: Playbook returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/Playbook'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    playbookId:
      name: playbookId
      in: path
      required: true
      description: Playbook unique identifier
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication failed or access key is missing
    NotFound:
      description: The requested resource was not found
  schemas:
    Playbook:
      type: object
      properties:
        Gsid:
          type: string
          description: Playbook unique identifier
        Name:
          type: string
          description: Playbook name
        Description:
          type: string
          description: Playbook description
        CTATypeId:
          type: string
          description: Associated CTA type
        IsActive:
          type: boolean
          description: Whether the playbook is active
        TaskTemplates:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Task template name
              description:
                type: string
                description: Task template description
              order:
                type: integer
                description: Task order
              daysFromCreation:
                type: integer
                description: Days offset from CTA creation for due date
          description: Ordered list of task templates
        CreatedDate:
          type: string
          format: date-time
        ModifiedDate:
          type: string
          format: date-time
  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