Gainsight CS
App · 20 actions
Query and manage Gainsight companies, relationships, custom objects, people and Timeline activities.
Actions
| Action | What it does |
|---|---|
| Create company | Create company. |
| Create custom object | Create custom object. |
| Create relationship | Create relationship. |
| Create timeline activity | Log an activity on a company's Timeline. |
| Delete company | Delete company. |
| Delete custom object | Delete custom object. |
| Delete relationship | Delete relationship. |
| Delete timeline activities | Delete timeline activities. |
| Get person | Get person. |
| Get person by email | Get person by email. |
| Get person deletion job | Get person deletion job. |
| Get person job | Get person job. |
| Query company | Query company. |
| Query custom object | Query custom object. |
| Query relationship | Query relationship. |
| Query timeline | Query timeline. |
| Update company | Update company. |
| Update custom object | Update custom object. |
| Update relationship | Update relationship. |
| Upsert relationship | Upsert relationship. |
Create company
Create company.
Inputs
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Create custom object
Create custom object.
Inputs
- Object name
object_nametextRequired - Object name.
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Create relationship
Create relationship.
Inputs
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Create timeline activity
Log an activity on a company's Timeline. Fill Company, Author email, Subject, Notes and Activity type; use Advanced records for other contexts.
Inputs
- Advanced records
recordslist - Use this list and Lookups for other activity contexts or tenant-specific fields. Leave the individual fields empty.
- Advanced lookups
lookupsobject - For advanced records, map values such as emails to Gainsight IDs. Leave empty when using the individual activity fields.
- Company
company_idtext - The company whose Timeline receives the activity.
- Author email
author_emailtext - The Gainsight user who owns the activity. Their email is resolved automatically.
- Subject
subjecttext - The activity subject.
- Notes
notestext - The activity notes. HTML is supported.
- Activity type
type_nametext - The activity type name from your Gainsight account, such as Update.
- Activity date
activity_datedate and time - The activity time. Leave empty to use Gainsight’s current time.
- External ID
external_idtext - Your unique activity identifier. Leave empty to generate one automatically.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}Delete company
Delete company.
Inputs
- Record
record_idtextRequired - Record ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}Delete custom object
Delete custom object.
Inputs
- Object name
object_nametextRequired - Object name.
- Record ID
record_idtextRequired - Record ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}Delete relationship
Delete relationship.
Inputs
- Record
record_idtextRequired - Record ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}Delete timeline activities
Delete timeline activities.
Inputs
- Activity IDs
activity_idslistRequired - Activity IDs.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}Get person
Get person.
Inputs
- Person ID
person_idtextRequired - Person ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {},
"result": true
}
}Get person by email
Get person by email.
Inputs
- Email
emailtextRequired - Email.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {},
"result": true
}
}Get person deletion job
Get person deletion job.
Inputs
- Job ID
job_idtextRequired - Job ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}Get person job
Get person job.
Inputs
- Job ID
job_idtextRequired - Job ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}Query company
Query company.
Inputs
- Select
selectlistRequired - Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
- Where
whereobject - Where.
- Order by
order_byobject - Order by.
- Limit
limitnumber - Limit.From 1 to 5000.
- Offset
offsetnumber - Offset.At least 0.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Query custom object
Query custom object.
Inputs
- Object name
object_nametextRequired - Object name.
- Select
selectlistRequired - Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
- Where
whereobject - Where.
- Order by
order_byobject - Order by.
- Limit
limitnumber - Limit.From 1 to 5000.
- Offset
offsetnumber - Offset.At least 0.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Query relationship
Query relationship.
Inputs
- Select
selectlistRequired - Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
- Where
whereobject - Where.
- Order by
order_byobject - Order by.
- Limit
limitnumber - Limit.From 1 to 5000.
- Offset
offsetnumber - Offset.At least 0.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Query timeline
Query timeline.
Inputs
- Select
selectlistRequired - Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
- Where
whereobject - Where.
- Order by
order_byobject - Order by.
- Limit
limitnumber - Limit.From 1 to 5000.
- Offset
offsetnumber - Offset.At least 0.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Update company
Update company.
Inputs
- Keys
keyslistRequired - Keys.
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Update custom object
Update custom object.
Inputs
- Object name
object_nametextRequired - Object name.
- Keys
keyslistRequired - Keys.
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Update relationship
Update relationship.
Inputs
- Keys
keyslistRequired - Keys.
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"records": []
},
"result": true
}
}Upsert relationship
Upsert relationship.
Inputs
- Keys
keyslistRequired - Keys.
- Records
recordslistRequired - Records.
- Lookups
lookupsobject - Lookups.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"result": true
}
}