# Gainsight Engagement API

**Canonical:** https://apis.io/apis/gainsight/gainsight-engagement-api/  
**Provider:** Gainsight — https://apis.io/providers/gainsight/  
**Base URL:** https://api.aptrinsic.com/v1  
**Documentation:** https://support.gainsight.com/PX/API_for_Developers/02About/Work_with_the_Gainsight_API

Gainsight Engagement API is one of 51 APIs that [Gainsight](https://apis.io/providers/gainsight/) publishes on the [APIs.io](https://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.

Engagement Operations

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/engagement` | Get engagements |
| PUT | `/v1/engagement/env` | Set engagement environment |
| PUT | `/v1/engagement/envs` | Set engagement environments |
| GET | `/v1/engagement/extended` | Get engagements with list of custom events from rules |
| GET | `/v1/engagement/metadata/survey` | getEngagementViewEvents |
| PUT | `/v1/engagement/state` | Set engagement state |
| GET | `/v1/engagement/{engagementId}` | Get engagement |
| DELETE | `/v1/engagement/{engagementId}` | deleteEngagement |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/openapi/gainsight-engagement-api-openapi.yml
- **LLMsTxt** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/llms/gainsight-px-llms.txt
- **APIReference** — https://px-apidocs.gainsight.com/
- **Documentation** — https://support.gainsight.com/PX/API_for_Developers
- **Authentication** — https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
- **API Keys** — https://support.gainsight.com/PX/API_for_Developers/02About/API_Keys
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/data-model/gainsight-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/errors/gainsight-problem-types.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/rate-limits/gainsight-rate-limits.yml

## Other Gainsight APIs (12)

- [Gainsight Accounts API](https://apis.io/apis/gainsight/gainsight-accounts-api/)
- [Gainsight Activities API](https://apis.io/apis/gainsight/gainsight-activities-api/)
- [Gainsight Activity Types API](https://apis.io/apis/gainsight/gainsight-activity-types-api/)
- [Gainsight Companies API](https://apis.io/apis/gainsight/gainsight-companies-api/)
- [Gainsight Company Team API](https://apis.io/apis/gainsight/gainsight-company-team-api/)
- [Gainsight Configuration API](https://apis.io/apis/gainsight/gainsight-configuration-api/)
- [Gainsight CTA Configuration API](https://apis.io/apis/gainsight/gainsight-cta-configuration-api/)
- [Gainsight CTAs API](https://apis.io/apis/gainsight/gainsight-ctas-api/)
- [Gainsight Custom Events API](https://apis.io/apis/gainsight/gainsight-custom-events-api/)
- [Gainsight Custom Objects API](https://apis.io/apis/gainsight/gainsight-custom-objects-api/)
- [Gainsight Engagements API](https://apis.io/apis/gainsight/gainsight-engagements-api/)
- [Gainsight Events API](https://apis.io/apis/gainsight/gainsight-events-api/)

## Tags

Engagement

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gainsight/gainsight-engagement-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gainsight/.