Gainsight Users API

Manage Gainsight users

Documentation GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /users List Gainsight users · Gainsight List users #

Ask an LLM

“Who are the users in my Gainsight instance?”

“Can I page through users by page number?”

Tell an agent

List users, page {pageNumber}.

Show all Gainsight users, {pageSize} per page.

POST /users Create or update a product user · Gainsight Create or update a user #

Ask an LLM

“How do I add an end user to Gainsight PX, or overwrite them if they exist?”

“Can I link a new PX user to an account when creating them?”

Tell an agent

Upsert PX user {identifyId} with email {email}.

Create or update user {identifyId} on account {accountId} with role {role}.

GET /users/{userId} Get a Gainsight user · Gainsight Get a user #

Ask an LLM

“Where can I look up a Gainsight user by user ID?”

“What details are stored for one user?”

Tell an agent

Get user {userId}.

Show the Gainsight user record {userId}.

PUT /users/{userId} Change a user's license or role · Gainsight Update a user #

Ask an LLM

“Can I change a Gainsight user's license type or user type?”

“Is it possible to update a user's role and email in Gainsight?”

Tell an agent

Set license type {LicenseType} for user {userId}.

Change user {userId}'s role to {Role} and user type to {UserType}.

PATCH /users/{userId} Partially update a product user · Gainsight Update a user #

Ask an LLM

“Can I patch just a PX user's title or phone?”

“Can a PX user be moved to a different account?”

Tell an agent

Patch user {userId} ({identifyId}) with title {title}.

Move PX user {userId} ({identifyId}) to account {accountId}.

DELETE /users/{userId} Delete a product user · Gainsight Delete a user #

Ask an LLM

“Can I delete a user from Gainsight PX by user ID?”

“How is a PX user removed?”

Tell an agent destructive · confirm first

Delete user {userId}.

Remove user {userId} from Gainsight PX.

POST /users/{userId}/deactivate Deactivate a user · Gainsight Deactivate a user #

Ask an LLM

“Is there a way to deactivate a user without deleting them?”

“Can I disable a Gainsight user account?”

Tell an agent destructive · confirm first

Deactivate user {userId}.

Disable the account of user {userId}.

GET /v1/users Filter users with the v1 API · Get users #

Ask an LLM

“Which users match a filter such as role or last seen date?”

“Does the v1 user listing support sorting and scroll paging?”

Tell an agent

Get v1 users matching {filter}.

List v1 users sorted by {sort}.

POST /v1/users Create a user with product tag keys · Create user #

Ask an LLM

“What does the v1 endpoint require to create a user?”

“Can I set a Salesforce contact ID when creating a v1 user?”

Tell an agent

Create v1 user {identifyId} under product key {propertyKeys}.

Add v1 user {identifyId} ({propertyKeys}) with email {email} and account {accountId}.

DELETE /v1/users/delete Delete a user whose ID has special characters · Delete user (identifyId passed via request body) #

Ask an LLM

“How do I delete a user whose identify ID can't go in the URL?”

“Is there a delete that takes the user ID in the request body?”

Tell an agent destructive · confirm first

Delete user {identifyId}, passing the ID in the body.

Hard-delete ({hardDelete}) body-identified user {identifyId}.

GET /v1/users/denylist/{identifyId} Check whether a user is denylisted · Get user Denylist flag #

Ask an LLM

“Is a given user on the denylist?”

“Are a user's events being ignored by PX?”

Tell an agent

Check the denylist flag for user {identifyId}.

Tell me if user {identifyId} is denied.

PUT /v1/users/denylist/{identifyId} Denylist a user · Update user Denylist flag #

Ask an LLM

“Can I make PX ignore all events from a test user?”

“Can I take a user off the denylist?”

Tell an agent

Set the denylist flag for user {identifyId} to {denied}.

Stop recording events from user {identifyId} by setting denied to {denied}.

PUT /v1/users/update Update a user whose ID has special characters · Update user (identifyId passed via request body) #

Ask an LLM

“How do I update a user whose identify ID can't go in the URL path?”

“Is there a v1 update that takes the user ID in the body?”

Tell an agent

Update user {identifyId} (ID in body) with product key {propertyKeys}.

Change the email of body-identified user {identifyId} to {email}, key {propertyKeys}.

GET /v1/users/{identifyId} Get a user with the v1 API · Get user #

Ask an LLM

“What does a user's full v1 profile contain when fetched by identify ID?”

“Can I see a user's number of visits and last seen date?”

Tell an agent

Retrieve v1 user {identifyId}.

Show visits and last seen date for user {identifyId}.

PUT /v1/users/{identifyId} Replace a user's data by identify ID · Update user #

Ask an LLM

“Can I overwrite a v1 user's record using the identify ID in the URL?”

“Can I update a user's title through the v1 API?”

Tell an agent

Replace v1 user {identifyId} with body ID {bodyIdentifyId} and product key {propertyKeys}.

Set v1 user {identifyId}'s title to {title} (body ID {bodyIdentifyId}, key {propertyKeys}).

DELETE /v1/users/{identifyId} Delete a user by identify ID · Delete user #

Ask an LLM

“If I delete a user and they come back within 7 days, is their history revived?”

“How do I permanently delete a user so they can't be revived?”

Tell an agent destructive · confirm first

Delete v1 user {identifyId}.

Hard-delete user {identifyId} with hardDelete {hardDelete}.

Gainsight Users API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification