Operations 11
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
Ask an LLM
“How can I page through every account tracked in Gainsight PX?”
“Can I sort the account list by when each account was last seen?”
Tell an agent
List product accounts sorted by {sort}.
Show the next page of PX accounts using scroll ID {scrollId}.
Ask an LLM
“How do I add a customer account to Gainsight PX, or overwrite it if it already exists?”
“Can one call both create a new PX account and upsert an existing one?”
Tell an agent
Upsert PX account {id} with the name {name}.
Create or update account {id} called {name} on the {plan} plan.
Ask an LLM
“What does Gainsight PX currently store for a single account?”
“Where can I look up one PX account's plan and custom attributes?”
Tell an agent
Fetch PX account {accountId}.
Show me the details stored for account {accountId}.
Ask an LLM
“Can I change just an account's plan without resending all its attributes?”
“How would I patch a single field on an existing PX account?”
Tell an agent
Patch account {accountId} so its plan is {plan}.
Change the Salesforce ID on account {accountId} to {sfdcId}.
Ask an LLM
“Can I remove an account from Gainsight PX entirely?”
“Is there a way to delete a PX account by its ID?”
Tell an agent destructive · confirm first
Delete PX account {accountId}.
Remove account {accountId} from Gainsight PX.
Ask an LLM
“Which accounts match a filter such as industry equals software in the v1 accounts API?”
“Does the v1 account listing support semicolon-separated filter expressions?”
Tell an agent
Get v1 accounts matching the filter {filter}.
Pull {pageSize} accounts per page from the v1 endpoint.
Ask an LLM
“What do I need to create a v1 account, and why does it ask for a property key?”
“Can I set health score, renewal date and industry when creating a v1 account?”
Tell an agent
Create v1 account {id} named {name} under product key {propertyKeys}.
Add account {id} called {name} for tag {propertyKeys} with renewal date {renewalDate}.
PUT
/v1/accounts/update
Update an account whose ID has special characters · Update account (accountId passed via request body)
#
Ask an LLM
“My account ID contains slashes, so how can I update it without putting it in the URL?”
“Is there an update route that takes the account ID in the body instead of the path?”
Tell an agent
Update account {id} (ID passed in the body) with name {name} and product key {propertyKeys}.
Set the health score of body-identified account {id} to {healthScore}, keeping name {name} and key {propertyKeys}.
Ask an LLM
“Can I fetch one account's full v1 record, including NPS and CSM?”
“What fields come back when I retrieve a single account from the v1 endpoint?”
Tell an agent
Retrieve v1 account {accountId}.
Look up the v1 record for account {accountId}, including its health score.
Ask an LLM
“How do I overwrite a v1 account's record when I have a clean account ID for the URL?”
“Can I update the number of employees on an account through the v1 API?”
Tell an agent
Replace v1 account {accountId} with name {name}, ID {id} and product key {propertyKeys}.
Update v1 account {accountId}: set employees to {numberOfEmployees}, id {id}, name {name}, key {propertyKeys}.
Ask an LLM
“Does deleting a v1 account also delete the users attached to it?”
“How can I wipe an account along with every user under it?”
Tell an agent destructive · confirm first
Delete v1 account {accountId} and cascade to its users.
Permanently remove account {accountId} and all associated users.
Documentation
Documentation
https://support.gainsight.com/PX/API_for_Developers
Authentication
https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
Documentation
https://support.gainsight.com/PX/API_for_Developers/APIs_for_Developers/PX_API
Documentation
https://gainsightpx.docs.apiary.io/
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation
Authentication
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Generate_REST_API/Generate_REST_API_Key
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Custom_Object_API/Gainsight_Custom_Object_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_(CTA)_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Timeline_API/Timeline_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Success_Plan_APIs/Success_Plan_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Data_Management_APIs/Data_Management_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_REST_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Events_API/Events_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/User_Management_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/SCIM_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/API_for_Company_Team_Record
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Customer_Goals_API/Customer_Goals_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Renewal_Center_API/Renewal_Center_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-account-2-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-account-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-response-entity-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-account-input-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-accounts-page-schema.json