ThoughtSpot

App · 25 actions

Get ThoughtSpot Liveboard and Answer data, run searches and export reports as PDF or Excel; manage users, groups, tags and sharing. Start a workflow when a Liveboard is added or changed, an Answer is saved, a user is added or a schedule runs.

Actions

ActionWhat it does
Create groupAdd a group, with the users you choose.
Create tagAdd a tag, such as certified, to put on content.
Create userAdd a ThoughtSpot user who signs in with a password, in the groups you choose.
Delete groupDelete a group.
Delete tagDelete a tag, taking it off everything it is on.
Delete userDelete a ThoughtSpot user.
Export AnswerSave a saved Answer as a CSV, Excel, PDF or PNG file in Lodol, to attach to an email or upload.
Export LiveboardSave a Liveboard as a PDF, PNG, CSV or Excel file in Lodol, to attach to an email or upload.
Find connectionsList the data warehouse connections ThoughtSpot reads from, such as Snowflake or BigQuery.
Find contentFind Liveboards, Answers or data objects (Models, worksheets, views and tables) by name or tag, with their links.
Find groupsFind groups by name, with their users.
Find schedulesList the schedules that email Liveboards, with who gets them and, if asked, their last five runs.
Find tagsList the tags, or the ones whose names contain some words.
Find usersFind users by name, email, group or account status.
Get Answer dataGet the rows of a saved Answer.
Get current userGet the ThoughtSpot user this connection signs in as: name, email, groups, privileges and Org.
Get data source columnsList the columns of a Model, worksheet or table, to write a search with 'Search data'.
Get Liveboard dataGet the data behind a Liveboard's visualizations as rows, to send in a report or copy to a sheet.
Get who has accessList the users and groups that can view or edit a Liveboard, Answer or data object.
Search dataRun a ThoughtSpot search on a Model, worksheet or table, such as [Revenue] [Region], and get the rows.
Share contentShare a Liveboard, Answer or data object with users and groups so they can view or edit it, or take their access away.
Tag contentPut tags on a Liveboard, Answer or data object.
Untag contentTake tags off a Liveboard, Answer or data object.
Update groupRename a group, change its description, or add users to it or take them out.
Update userChange a user's name, email, status or visibility, or add them to groups or take them out.

Create group

Add a group, with the users you choose.

Inputs

Namegroup_nametextRequired
A unique name for the group.
Display namedisplay_nametext
The name ThoughtSpot shows. Defaults to the name.
Descriptiondescriptiontext
What the group is for.
Usersuserslist
The users to put in it.
Visibility when sharingvisibilitytext
Whether people can find them when sharing. Leave empty to keep ThoughtSpot's default.One of: SHARABLE (Others can share with them), NON_SHARABLE (Hidden when sharing).

Outputs

groupobject
A group
Example output
{
  "group": {
    "created_at": "2026-10-11T16:00:00Z",
    "description": "Everyone who reads the sales Liveboards",
    "display_name": "Sales analysts",
    "id": "3c4d5e6f-0004-4d5e-9f6a-7b8c9d0e1f2a",
    "modified_at": "2026-10-11T16:00:00Z",
    "name": "sales-analysts",
    "privileges": [],
    "sub_groups": [],
    "type": "LOCAL_GROUP",
    "user_count": 1,
    "users": [
      "tsadmin"
    ],
    "visibility": "SHARABLE"
  }
}

Create tag

Add a tag, such as certified, to put on content.

Inputs

Nametag_nametextRequired
The tag's name.
Colorcolortext
A hex color, such as #ff78a9. Leave empty for ThoughtSpot's.

Outputs

tagobject
A tag
Example output
{
  "tag": {
    "color": "#fbc17c",
    "created_at": "2026-10-11T16:00:00Z",
    "id": "3c4d5e6f-0008-4b9c-9d0e-1f2a3b4c5d6e",
    "name": "certified"
  }
}

Create user

Add a ThoughtSpot user who signs in with a password, in the groups you choose.

Inputs

UsernameusernametextRequired
The unique name they sign in with, often their email address.
Full namedisplay_nametextRequired
Their name as ThoughtSpot shows it.
EmailemailtextRequired
Their email address.
Passwordpasswordtext
Their first password. Leave empty to have ThoughtSpot email them to set one, where it does.
Groupsgroupslist
The groups to put them in.
Visibility when sharingvisibilitytext
Whether people can find them when sharing. Leave empty to keep ThoughtSpot's default.One of: SHARABLE (Others can share with them), NON_SHARABLE (Hidden when sharing).
Send welcome emailsend_welcome_emailtrue/false
Have ThoughtSpot email them a welcome.

Outputs

userobject
A ThoughtSpot user
Example output
{
  "user": {
    "account_status": "ACTIVE",
    "account_type": "LOCAL_USER",
    "created_at": "2023-11-13T18:26:40Z",
    "display_name": "TS Admin",
    "email": "tsadmin@example.com",
    "groups": [
      "sales-analysts"
    ],
    "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
    "modified_at": "2023-11-13T18:27:40Z",
    "name": "tsadmin",
    "org": "Primary",
    "privileges": [],
    "visibility": "SHARABLE"
  }
}

Delete group

Delete a group. Its users stay, without its access.

Inputs

GroupgrouptextRequired
The group. Pick one, or give its GUID or name.

Outputs

deletedtrue/false
Always true once deleted
grouptext
The group deleted
Example output
{
  "deleted": true,
  "group": "3c4d5e6f-0004-4d5e-9f6a-7b8c9d0e1f2a"
}

Delete tag

Delete a tag, taking it off everything it is on.

Inputs

TagtagtextRequired
The tag. Pick one, or give its GUID or name.

Outputs

deletedtrue/false
Always true once deleted
tagtext
The tag deleted
Example output
{
  "deleted": true,
  "tag": "3c4d5e6f-0008-4b9c-9d0e-1f2a3b4c5d6e"
}

Delete user

Delete a ThoughtSpot user. The content they made stays.

Inputs

UserusertextRequired
The user. Pick one, or give their GUID or username.

Outputs

deletedtrue/false
Always true once deleted
usertext
The user deleted
Example output
{
  "deleted": true,
  "user": "59481331-ee53-42be-a548-bd87be6ddd4a"
}

Export Answer

Save a saved Answer as a CSV, Excel, PDF or PNG file in Lodol, to attach to an email or upload.

Inputs

AnsweranswertextRequired
The saved Answer. Pick one, or give its GUID or name.
Formatfile_formattext
The kind of file. Defaults to CSV.One of: CSV, XLSX (Excel (XLSX)), PDF, PNG (PNG image). Default: CSV.

Outputs

answer_idtext
The Answer exported
content_typetext
The file's type, such as application/pdf
document_reftext
The saved file's reference in Lodol, to attach or upload
file_formattext
PDF, PNG, CSV or XLSX
filenametext
The file's name
size_bytesnumber
Its size in bytes
urltext
Where Lodol serves the file
Example output
{
  "answer_id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
  "content_type": "text/csv",
  "document_ref": "doc_0123456789abcdef0123456789abcdef",
  "file_format": "CSV",
  "filename": "answer-3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a.csv",
  "size_bytes": 2048,
  "url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef"
}

Export Liveboard

Save a Liveboard as a PDF, PNG, CSV or Excel file in Lodol, to attach to an email or upload. CSV or Excel of several visualizations comes as a zip.

Inputs

LiveboardliveboardtextRequired
The Liveboard. Pick one, or give its GUID or name.
Formatfile_formattext
The kind of file. Defaults to PDF.One of: PDF, PNG (PNG image), CSV, XLSX (Excel (XLSX)). Default: PDF.
Visualizationsvisualizationslist
Only these visualizations, by GUID or name. Leave empty for every one on the Liveboard.
Page orientationpage_orientationtext
For a PDF: portrait or landscape. Defaults to portrait.Only when Format is PDF. One of: PORTRAIT, LANDSCAPE.

Outputs

content_typetext
The file's type, such as application/pdf
document_reftext
The saved file's reference in Lodol, to attach or upload
file_formattext
PDF, PNG, CSV or XLSX
filenametext
The file's name
liveboard_idtext
The Liveboard exported
size_bytesnumber
Its size in bytes
urltext
Where Lodol serves the file
Example output
{
  "content_type": "application/pdf",
  "document_ref": "doc_0123456789abcdef0123456789abcdef",
  "file_format": "PDF",
  "filename": "liveboard-1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e.pdf",
  "liveboard_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "size_bytes": 482211,
  "url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef"
}

Find connections

List the data warehouse connections ThoughtSpot reads from, such as Snowflake or BigQuery. Needs the Can manage data privilege.

Inputs

Name containsname_containstext
Words in the name. Leave blank for all.
How manylimitnumber
The most results to return, up to 500. Defaults to 25.From 1 to 500.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

connectionslist
The connections
countnumber
How many were returned
Example output
{
  "connections": [
    {
      "data_warehouse_type": "SNOWFLAKE",
      "description": "Snowflake connection for the sales warehouse",
      "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c",
      "name": "Snowflake Sales"
    }
  ],
  "count": 1
}

Find content

Find Liveboards, Answers or data objects (Models, worksheets, views and tables) by name or tag, with their links.

Inputs

Kind of objectobject_typetext
What to find. Defaults to Liveboards.One of: LIVEBOARD (Liveboards), ANSWER (Answers), LOGICAL_TABLE (Models, worksheets, views and tables). Default: LIVEBOARD.
Name containsname_containstext
Words in the name. Leave blank for all.
Tagtagtext
Only objects with this tag. Leave blank for any.
Ordersort_bytext
How to order them. Defaults to most recently changed first.One of: MODIFIED (Most recently changed first), CREATED (Newest first), NAME (Name, A to Z), VIEWS (Most viewed first). Default: MODIFIED.
How manylimitnumber
The most results to return, up to 500. Defaults to 25.From 1 to 500.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

countnumber
How many were returned
objectslist
What was found
Example output
{
  "count": 1,
  "objects": [
    {
      "author": "TS Admin",
      "created_at": "2026-10-11T16:00:00Z",
      "description": "Weekly revenue by region",
      "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "modified_at": "2026-10-11T16:01:00Z",
      "name": "Sales Overview",
      "subtype": "",
      "tags": [
        "certified"
      ],
      "type": "LIVEBOARD",
      "url": "https://mycompany.thoughtspot.cloud/#/pinboard/1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ]
}

Find groups

Find groups by name, with their users.

Inputs

Name containsname_containstext
Words in the name. Leave blank for all.
How manylimitnumber
The most results to return, up to 500. Defaults to 25.From 1 to 500.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

countnumber
How many were returned
groupslist
The groups
Example output
{
  "count": 1,
  "groups": [
    {
      "created_at": "2026-10-11T16:00:00Z",
      "description": "Everyone who reads the sales Liveboards",
      "display_name": "Sales analysts",
      "id": "3c4d5e6f-0004-4d5e-9f6a-7b8c9d0e1f2a",
      "modified_at": "2026-10-11T16:00:00Z",
      "name": "sales-analysts",
      "privileges": [],
      "sub_groups": [],
      "type": "LOCAL_GROUP",
      "user_count": 1,
      "users": [
        "tsadmin"
      ],
      "visibility": "SHARABLE"
    }
  ]
}

Find schedules

List the schedules that email Liveboards, with who gets them and, if asked, their last five runs.

Inputs

Liveboardliveboardtext
Only this Liveboard's schedules. Leave blank for all.
Include recent runsinclude_runstrue/false
Also return each schedule's last five runs and how they went.Default: false.

Outputs

countnumber
How many were returned
scheduleslist
The schedules
Example output
{
  "count": 1,
  "schedules": [
    {
      "author": "tsadmin",
      "cron": "0 0 8 * * 1",
      "description": "Sales Overview every Monday at 8am",
      "file_format": "PDF",
      "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
      "liveboard_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "liveboard_name": "Sales Overview",
      "name": "Monday sales report",
      "recipient_emails": [
        "team@example.com"
      ],
      "recipients": [
        "sales-analysts"
      ],
      "runs": [
        {
          "detail": "",
          "ended_at": "2026-11-09T13:00:42Z",
          "id": "8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e",
          "started_at": "2026-11-09T13:00:00Z",
          "status": "SUCCESS"
        }
      ],
      "status": "ACTIVE",
      "time_zone": "America/New_York"
    }
  ]
}

Find tags

List the tags, or the ones whose names contain some words.

Inputs

Name containsname_containstext
Words in the name. Leave blank for all.

Outputs

countnumber
How many were returned
tagslist
The tags
Example output
{
  "count": 1,
  "tags": [
    {
      "color": "#fbc17c",
      "created_at": "2026-10-11T16:00:00Z",
      "id": "3c4d5e6f-0008-4b9c-9d0e-1f2a3b4c5d6e",
      "name": "certified"
    }
  ]
}

Find users

Find users by name, email, group or account status.

Inputs

Name containsname_containstext
Words in the name. Leave blank for all.
Emailemailtext
Only the user with this email address.
Groupgrouptext
Only users in this group.
Account statusaccount_statustext
Only users in this state. Leave empty for any.One of: ACTIVE, INACTIVE, LOCKED, EXPIRED, PENDING.
How manylimitnumber
The most results to return, up to 500. Defaults to 25.From 1 to 500.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

countnumber
How many were returned
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "account_status": "ACTIVE",
      "account_type": "LOCAL_USER",
      "created_at": "2023-11-13T18:26:40Z",
      "display_name": "TS Admin",
      "email": "tsadmin@example.com",
      "groups": [
        "Administrators"
      ],
      "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
      "modified_at": "2023-11-13T18:27:40Z",
      "name": "tsadmin",
      "org": "Primary",
      "privileges": [
        "ADMINISTRATION",
        "AUTHORING",
        "DATADOWNLOADING"
      ],
      "visibility": "SHARABLE"
    }
  ]
}

Get Answer data

Get the rows of a saved Answer.

Inputs

AnsweranswertextRequired
The saved Answer. Pick one, or give its GUID or name.
How manylimitnumber
The most rows to return, up to 10,000. Defaults to 100.From 1 to 10000.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

answer_idtext
The Answer's GUID
answer_nametext
The Answer's name
columnslist
The column names, in order
row_countnumber
How many rows were returned
rowslist
The rows, each an object keyed by column name
total_row_countnumber
How many rows there are in all
Example output
{
  "answer_id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a",
  "answer_name": "Revenue by Region",
  "columns": [
    "Region",
    "Total Revenue"
  ],
  "row_count": 2,
  "rows": [
    {
      "Region": "East",
      "Total Revenue": 125000
    },
    {
      "Region": "West",
      "Total Revenue": 98000
    }
  ],
  "total_row_count": 2
}

Get current user

Get the ThoughtSpot user this connection signs in as: name, email, groups, privileges and Org.

Inputs

None.

Outputs

userobject
A ThoughtSpot user
Example output
{
  "user": {
    "account_status": "ACTIVE",
    "account_type": "LOCAL_USER",
    "created_at": "2023-11-13T18:26:40Z",
    "display_name": "TS Admin",
    "email": "tsadmin@example.com",
    "groups": [
      "Administrators"
    ],
    "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
    "modified_at": "2023-11-13T18:27:40Z",
    "name": "tsadmin",
    "org": "Primary",
    "privileges": [
      "ADMINISTRATION",
      "AUTHORING",
      "DATADOWNLOADING"
    ],
    "visibility": "SHARABLE"
  }
}

Get data source columns

List the columns of a Model, worksheet or table, to write a search with 'Search data'.

Inputs

Data sourcedata_sourcetextRequired
The Model, worksheet, view or table. Pick one, or give its GUID.

Outputs

columnslist
Its columns, hidden ones left out
countnumber
How many were returned
data_source_idtext
The data object's GUID
data_source_nametext
Its name
subtypetext
WORKSHEET, ONE_TO_ONE_LOGICAL (a table), SQL_VIEW and so on
urltext
Its address in ThoughtSpot
Example output
{
  "columns": [
    {
      "column_type": "ATTRIBUTE",
      "data_type": "VARCHAR",
      "description": "",
      "hidden": false,
      "id": "00000034-0000-4000-8000-000000000034",
      "name": "Region"
    },
    {
      "column_type": "MEASURE",
      "data_type": "DOUBLE",
      "description": "Sales after discounts",
      "hidden": false,
      "id": "00000035-0000-4000-8000-000000000035",
      "name": "Revenue"
    }
  ],
  "count": 2,
  "data_source_id": "cd252e5c-b552-49a8-821d-3eadaa049cca",
  "data_source_name": "Retail Sales",
  "subtype": "WORKSHEET",
  "url": "https://mycompany.thoughtspot.cloud/#/data/tables/cd252e5c-b552-49a8-821d-3eadaa049cca"
}

Get Liveboard data

Get the data behind a Liveboard's visualizations as rows, to send in a report or copy to a sheet.

Inputs

LiveboardliveboardtextRequired
The Liveboard. Pick one, or give its GUID or name.
Visualizationsvisualizationslist
Only these visualizations, by GUID or name. Leave empty for every one on the Liveboard.
How manylimitnumber
The most rows to return, up to 10,000. Defaults to 100.From 1 to 10000.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

liveboard_idtext
The Liveboard's GUID
liveboard_nametext
The Liveboard's name
visualization_countnumber
How many were returned
visualizationslist
Each visualization's data
Example output
{
  "liveboard_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "liveboard_name": "Sales Overview",
  "visualization_count": 1,
  "visualizations": [
    {
      "columns": [
        "Region",
        "Total Revenue"
      ],
      "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
      "name": "Revenue by Region",
      "row_count": 2,
      "rows": [
        {
          "Region": "East",
          "Total Revenue": 125000
        },
        {
          "Region": "West",
          "Total Revenue": 98000
        }
      ],
      "total_row_count": 2
    }
  ]
}

Get who has access

List the users and groups that can view or edit a Liveboard, Answer or data object.

Inputs

Kind of objectobject_typetextRequired
Whether it is a Liveboard, an Answer or a data object.One of: LIVEBOARD (Liveboards), ANSWER (Answers), LOGICAL_TABLE (Models, worksheets, views and tables).
Objectobject_idtextRequired
The object. Pick one, or give its GUID or name.

Outputs

authortext
Who made it
countnumber
How many were returned
object_idtext
The object's GUID
object_nametext
Its name
object_typetext
The kind of object
ownertext
Its owner
permissionslist
Who has access
Example output
{
  "author": "tsadmin",
  "count": 2,
  "object_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "object_name": "Sales Overview",
  "object_type": "LIVEBOARD",
  "owner": "Sales Overview",
  "permissions": [
    {
      "permission": "MODIFY",
      "principal_id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b",
      "principal_name": "Administrator",
      "principal_type": "USER_GROUP"
    },
    {
      "permission": "MODIFY",
      "principal_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
      "principal_name": "tsadmin",
      "principal_type": "USER"
    }
  ]
}

Search data

Run a ThoughtSpot search on a Model, worksheet or table, such as [Revenue] [Region], and get the rows.

Inputs

Data sourcedata_sourcetextRequired
The Model, worksheet, view or table to search. Pick one, or give its GUID.
SearchquerytextRequired
Column names in square brackets, with any keywords, as typed in ThoughtSpot's search bar: [Revenue] [Region] top 10.
How manylimitnumber
The most rows to return, up to 10,000. Defaults to 100.From 1 to 10000.
Skipoffsetnumber
How many to skip, for the next page: the last skip plus how many.At least 0.

Outputs

columnslist
The column names, in order
data_sourcetext
The data object searched
querytext
The search run
row_countnumber
How many rows were returned
rowslist
The rows, each an object keyed by column name
total_row_countnumber
How many rows there are in all
Example output
{
  "columns": [
    "Region",
    "Total Revenue"
  ],
  "data_source": "cd252e5c-b552-49a8-821d-3eadaa049cca",
  "query": "[Revenue] [Region]",
  "row_count": 2,
  "rows": [
    {
      "Region": "East",
      "Total Revenue": 125000
    },
    {
      "Region": "West",
      "Total Revenue": 98000
    }
  ],
  "total_row_count": 2
}

Share content

Share a Liveboard, Answer or data object with users and groups so they can view or edit it, or take their access away.

Inputs

Kind of objectobject_typetextRequired
Whether it is a Liveboard, an Answer or a data object.One of: LIVEBOARD (Liveboards), ANSWER (Answers), LOGICAL_TABLE (Models, worksheets, views and tables).
Objectobject_idtextRequired
The object. Pick one, or give its GUID or name.
Usersuserslist
Users to share with.
Groupsgroupslist
Groups to share with.
Accessaccesstext
What they can do. Defaults to view.One of: READ_ONLY (Can view), MODIFY (Can edit), NO_ACCESS (No access (stop sharing)). Default: READ_ONLY.
Messagemessagetext
A note in the email ThoughtSpot sends them.
Email themnotifytrue/false
Have ThoughtSpot email them that it was shared. Defaults to yes.Default: true.

Outputs

accesstext
READ_ONLY, MODIFY or NO_ACCESS
groupslist
The groups
object_idtext
The object
object_typetext
The kind of object
sharedtrue/false
Always true once shared
userslist
The users
Example output
{
  "access": "READ_ONLY",
  "groups": [],
  "object_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "object_type": "LIVEBOARD",
  "shared": true,
  "users": [
    "59481331-ee53-42be-a548-bd87be6ddd4a"
  ]
}

Tag content

Put tags on a Liveboard, Answer or data object.

Inputs

TagstagslistRequired
The tags to put on it.
Kind of objectobject_typetextRequired
Whether it is a Liveboard, an Answer or a data object.One of: LIVEBOARD (Liveboards), ANSWER (Answers), LOGICAL_TABLE (Models, worksheets, views and tables).
Objectobject_idtextRequired
The object. Pick one, or give its GUID or name.

Outputs

assignedtrue/false
Always true once tagged
object_idtext
The object
object_typetext
The kind of object
tagslist
The tags
Example output
{
  "assigned": true,
  "object_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "object_type": "LIVEBOARD",
  "tags": [
    "certified"
  ]
}

Untag content

Take tags off a Liveboard, Answer or data object.

Inputs

TagstagslistRequired
The tags to take off.
Kind of objectobject_typetextRequired
Whether it is a Liveboard, an Answer or a data object.One of: LIVEBOARD (Liveboards), ANSWER (Answers), LOGICAL_TABLE (Models, worksheets, views and tables).
Objectobject_idtextRequired
The object. Pick one, or give its GUID or name.

Outputs

object_idtext
The object
object_typetext
The kind of object
tagslist
The tags
unassignedtrue/false
Always true once untagged
Example output
{
  "object_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "object_type": "LIVEBOARD",
  "tags": [
    "certified"
  ],
  "unassigned": true
}

Update group

Rename a group, change its description, or add users to it or take them out.

Inputs

GroupgrouptextRequired
The group. Pick one, or give its GUID or name.
Display namedisplay_nametext
A new display name. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Usersuserslist
Users to add, or take out.
Change to usersuser_changetext
Whether to add the users, take them out, or make them the only ones. Defaults to add.One of: ADD (Add to the ones already there), REMOVE (Remove these), REPLACE (Replace the ones there with these). Default: ADD.

Outputs

groupobject
A group
Example output
{
  "group": {
    "created_at": "2026-10-11T16:00:00Z",
    "description": "Everyone who reads the sales Liveboards",
    "display_name": "Sales analysts",
    "id": "3c4d5e6f-0004-4d5e-9f6a-7b8c9d0e1f2a",
    "modified_at": "2026-10-11T16:00:00Z",
    "name": "sales-analysts",
    "privileges": [],
    "sub_groups": [],
    "type": "LOCAL_GROUP",
    "user_count": 1,
    "users": [
      "tsadmin"
    ],
    "visibility": "SHARABLE"
  }
}

Update user

Change a user's name, email, status or visibility, or add them to groups or take them out.

Inputs

UserusertextRequired
The user. Pick one, or give their GUID or username.
Full namedisplay_nametext
A new full name. Leave empty to keep it.
Emailemailtext
A new email address. Leave empty to keep it.
Account statusaccount_statustext
Set them active or inactive, say. Leave empty to keep it.One of: ACTIVE, INACTIVE, LOCKED, EXPIRED, PENDING.
Visibility when sharingvisibilitytext
Whether people can find them when sharing. Leave empty to keep ThoughtSpot's default.One of: SHARABLE (Others can share with them), NON_SHARABLE (Hidden when sharing).
Groupsgroupslist
Groups to add them to, or take them out of.
Change to groupsgroup_changetext
Whether to add them to the groups, take them out, or make these their only groups. Defaults to add.One of: ADD (Add to the ones already there), REMOVE (Remove these), REPLACE (Replace the ones there with these). Default: ADD.

Outputs

userobject
A ThoughtSpot user
Example output
{
  "user": {
    "account_status": "ACTIVE",
    "account_type": "LOCAL_USER",
    "created_at": "2023-11-13T18:26:40Z",
    "display_name": "TS Admin",
    "email": "tsadmin@example.com",
    "groups": [
      "Administrators"
    ],
    "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
    "modified_at": "2023-11-13T18:27:40Z",
    "name": "tsadmin",
    "org": "Primary",
    "privileges": [
      "ADMINISTRATION",
      "AUTHORING",
      "DATADOWNLOADING"
    ],
    "visibility": "SHARABLE"
  }
}

On this page