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

Gainsight Users API

Manage Gainsight users

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{domain}.gainsightcloud.com/v1.

7 operations 3 paths 5 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.gainsight.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Gainsight Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as accessKey (apiKey). By default, every request must be authenticated.

  • apiKey — Gainsight CS REST API access key

Paths & Operations 7

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

Users 7

Manage Gainsight users

GET
/users
Gainsight List users
listUsers 2 params → 200401
POST
/users
Gainsight Create or update a user
createUser body → 200400401
GET
/users/{userId}
Gainsight Get a user
getUser 1 param → 200401404
PUT
/users/{userId}
Gainsight Update a user
updateUser 1 param body → 200400401404
PATCH
/users/{userId}
Gainsight Update a user
updateUser 1 param body → 200401404
DELETE
/users/{userId}
Gainsight Delete a user
deleteUser 1 param → 204401404
POST
/users/{userId}/deactivate
Gainsight Deactivate a user
deactivateUser 1 param → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are User (17 properties), GainsightUser (11 properties), UserInput (10 properties), GainsightUserInput (6 properties). Each schema is shown below with its type and property counts.

GainsightUserInput
object
6 properties
User
object
17 properties
UserInput
object
10 properties 1 required
ApiResponse
object
4 properties
GainsightUser
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gainsight-users-api-openapi.yml Raw ↑

Other APIs Gainsight publishes across the network.

Gainsight Accounts API
Gainsight Activities API
Gainsight Activity Types API
Gainsight Companies API
Gainsight Company Team API
Gainsight Configuration API
Gainsight CTA Configuration API
Gainsight CTAs API
Gainsight Custom Events API
Gainsight Custom Objects API
Gainsight Engagements API
Gainsight Events API
Where this information came from

This is an independent, third-party profile of Gainsight Users 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.