Gainsight CS Customer Goals API — Goals

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS Customer Goals API — Goals
  description: 'Gainsight CS Customer Goals API — Goals. 4 operations. Lead operation: Gainsight Create a customer goal. Self-contained
    Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - Goals
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: cs-customer-goals-goals
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS Customer Goals API — Goals business capability. Self-contained, no shared references.
    resources:
    - name: goals
      path: /goals
      operations:
      - name: creategoal
        method: POST
        description: Gainsight Create a customer goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: goals-search
      path: /goals/search
      operations:
      - name: searchgoals
        method: POST
        description: Gainsight Search customer goals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: goals-goalId
      path: /goals/{goalId}
      operations:
      - name: getgoal
        method: GET
        description: Gainsight Get a customer goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategoal
        method: PUT
        description: Gainsight Update a customer goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: accessKey
      value: '{{env.GAINSIGHT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cs-customer-goals-goals-rest
    port: 8080
    description: REST adapter for Gainsight CS Customer Goals API — Goals. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/goals
      name: goals
      description: REST surface for goals.
      operations:
      - method: POST
        name: creategoal
        description: Gainsight Create a customer goal
        call: cs-customer-goals-goals.creategoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goals/search
      name: goals-search
      description: REST surface for goals-search.
      operations:
      - method: POST
        name: searchgoals
        description: Gainsight Search customer goals
        call: cs-customer-goals-goals.searchgoals
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goals/{goalid}
      name: goals-goalid
      description: REST surface for goals-goalId.
      operations:
      - method: GET
        name: getgoal
        description: Gainsight Get a customer goal
        call: cs-customer-goals-goals.getgoal
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updategoal
        description: Gainsight Update a customer goal
        call: cs-customer-goals-goals.updategoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-customer-goals-goals-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS Customer Goals API — Goals. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: gainsight-create-customer-goal
      description: Gainsight Create a customer goal
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cs-customer-goals-goals.creategoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-search-customer-goals
      description: Gainsight Search customer goals
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: cs-customer-goals-goals.searchgoals
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-customer-goal
      description: Gainsight Get a customer goal
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-customer-goals-goals.getgoal
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-update-customer-goal
      description: Gainsight Update a customer goal
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cs-customer-goals-goals.updategoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.