How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Gainsight

Gainsight Engagement API

Engagement Operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Gainsight Engagement API is one of 51 APIs that Gainsight publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Engagement. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

This API exposes 8 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 0.1.6.

Requests are made against a single base URL, https://api.aptrinsic.com/.

8 operations 7 paths 12 schemas 1 DELETE4 GET3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.6
Base URL
https://api.aptrinsic.com/v1
Authentication
API Key
Contact
Gainsight PX
License
internal
Resource Areas
1

Authentication & Security 1

Gainsight Engagement API declares 1 security scheme for authenticating requests. An API key is passed in the header as Aptrinsic API Key (X-APTRINSIC-API-KEY).

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Engagement 8

Engagement Operations

GET
/v1/engagement
Get engagements
getEngagementsUsingGET 4 params → 200400401429
PUT
/v1/engagement/env
Set engagement environment
changeEngagementEnvUsingPUT body → 200400401404429
PUT
/v1/engagement/envs
Set engagement environments
changeEngagementEnvsUsingPUT body → 200400401404429
GET
/v1/engagement/extended
Get engagements with list of custom events from rules
getEngagementsExtendedUsingGET 3 params → 200400401429
GET
/v1/engagement/metadata/survey
getEngagementViewEvents
getEngagementViewEventsUsingGET 1 param → 200
PUT
/v1/engagement/state
Set engagement state
changeEngagementStateUsingPUT body → 200400401404429
GET
/v1/engagement/{engagementId}
Get engagement
getEngagementUsingGET 1 param → 200400401404429
DELETE
/v1/engagement/{engagementId}
deleteEngagement
deleteEngagementUsingDELETE 1 param → 200400401429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Engagement (10 properties), EngagementWithCustomEvents (8 properties), EngagementStateChangeRequest (3 properties), EngagementsPage (3 properties). Each schema is shown below with its type and property counts.

EngagementEnvChangeRequest
object
Engagement state change request
2 properties 2 required
Engagement
object
Engagement object
10 properties 6 required
CustomEventMetadata
object
Custom event metadata
2 properties 1 required
ResponseEntity
object
3 properties
EngagementsPage
object
3 properties
EngagementStateChangeRequest
object
Engagement state change request
3 properties 2 required
EngagementEnvironmentsChangeResponse
object
Engagement environments change response
2 properties
EngagementWithCustomEvents
object
Engagement object
8 properties 7 required
EngagementsWithCustomEventsPage
object
3 properties
EngagementEnvChangeResponse
object
Engagement environment change response
2 properties
LocalizationStatus
object
2 properties
EngagementEnvironmentsChangeRequest
object
Engagement environments change request
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gainsight-engagement-api-openapi.yml Raw ↑

Other APIs Gainsight publishes across the network.

Gainsight Accounts API
AE Profile APIs.io
Gainsight Activities API
AE Profile APIs.io
Gainsight Activity Types API
AE Profile APIs.io
Gainsight Companies API
AE Profile APIs.io
Gainsight Company Team API
AE Profile APIs.io
Gainsight Configuration API
AE Profile APIs.io
Gainsight CTA Configuration API
AE Profile APIs.io
Gainsight CTAs API
AE Profile APIs.io
Gainsight Custom Events API
AE Profile APIs.io
Gainsight Custom Objects API
AE Profile APIs.io
Gainsight Engagements API
AE Profile APIs.io
Gainsight Events API
AE Profile APIs.io
#Engagement
← Back to G APIs
API Details
ID
gainsight:gainsight-engagement-api
Base URL
https://api.aptrinsic.com/v1
Docs
https://support.gainsight.com/PX/API_for_Developers/02About/Work_with_the_Gainsight_API
Provider
Gainsight
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gainsight-engagement-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gainsight-engagement-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Gainsight Engagement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.