Gainsight CS

App · 20 actions

Query and manage Gainsight companies, relationships, custom objects, people and Timeline activities.

Actions

ActionWhat it does
Create companyCreate company.
Create custom objectCreate custom object.
Create relationshipCreate relationship.
Create timeline activityLog an activity on a company's Timeline.
Delete companyDelete company.
Delete custom objectDelete custom object.
Delete relationshipDelete relationship.
Delete timeline activitiesDelete timeline activities.
Get personGet person.
Get person by emailGet person by email.
Get person deletion jobGet person deletion job.
Get person jobGet person job.
Query companyQuery company.
Query custom objectQuery custom object.
Query relationshipQuery relationship.
Query timelineQuery timeline.
Update companyUpdate company.
Update custom objectUpdate custom object.
Update relationshipUpdate relationship.
Upsert relationshipUpsert relationship.

Create company

Create company.

Inputs

RecordsrecordslistRequired
Records.
Lookupslookupsobject
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 nameobject_nametextRequired
Object name.
RecordsrecordslistRequired
Records.
Lookupslookupsobject
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

RecordsrecordslistRequired
Records.
Lookupslookupsobject
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 recordsrecordslist
Use this list and Lookups for other activity contexts or tenant-specific fields. Leave the individual fields empty.
Advanced lookupslookupsobject
For advanced records, map values such as emails to Gainsight IDs. Leave empty when using the individual activity fields.
Companycompany_idtext
The company whose Timeline receives the activity.
Author emailauthor_emailtext
The Gainsight user who owns the activity. Their email is resolved automatically.
Subjectsubjecttext
The activity subject.
Notesnotestext
The activity notes. HTML is supported.
Activity typetype_nametext
The activity type name from your Gainsight account, such as Update.
Activity dateactivity_datedate and time
The activity time. Leave empty to use Gainsight’s current time.
External IDexternal_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

Recordrecord_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 nameobject_nametextRequired
Object name.
Record IDrecord_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

Recordrecord_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 IDsactivity_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 IDperson_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

EmailemailtextRequired
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 IDjob_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 IDjob_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

SelectselectlistRequired
Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
Wherewhereobject
Where.
Order byorder_byobject
Order by.
Limitlimitnumber
Limit.From 1 to 5000.
Offsetoffsetnumber
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 nameobject_nametextRequired
Object name.
SelectselectlistRequired
Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
Wherewhereobject
Where.
Order byorder_byobject
Order by.
Limitlimitnumber
Limit.From 1 to 5000.
Offsetoffsetnumber
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

SelectselectlistRequired
Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
Wherewhereobject
Where.
Order byorder_byobject
Order by.
Limitlimitnumber
Limit.From 1 to 5000.
Offsetoffsetnumber
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

SelectselectlistRequired
Fields to return, using their names from Administration > Data Management. Include Gsid when chaining records.
Wherewhereobject
Where.
Order byorder_byobject
Order by.
Limitlimitnumber
Limit.From 1 to 5000.
Offsetoffsetnumber
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

KeyskeyslistRequired
Keys.
RecordsrecordslistRequired
Records.
Lookupslookupsobject
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 nameobject_nametextRequired
Object name.
KeyskeyslistRequired
Keys.
RecordsrecordslistRequired
Records.
Lookupslookupsobject
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

KeyskeyslistRequired
Keys.
RecordsrecordslistRequired
Records.
Lookupslookupsobject
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

KeyskeyslistRequired
Keys.
RecordsrecordslistRequired
Records.
Lookupslookupsobject
Lookups.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "result": true
  }
}

On this page