# REST API v1 Reference (Legacy endpoints)

> For the complete documentation index, see [llms.txt](https://developers.thoughtspot.com/docs/llms.txt)

Source: https://developers.thoughtspot.com/docs/rest-api-reference

# REST API v1 Reference (Legacy endpoints)

> **IMPORTANT:** The REST API v1 endpoints are deprecated and replaced with the REST API v2 endpoints. Your existing integrations with REST API v1 endpoints will continue to function without disruption until further notice. ThoughtSpot strongly recommends migrating your integrations to the REST API v2 endpoints.

## Orgs management

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/org/]({{navprefix}}/{{org-api}}#createOrg)`  
Creates an Org object.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**GET** /tspublic/v1/org/]({{navprefix}}/{{org-api}}#getOrg)`  
Gets an Org object.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**PUT** /tspublic/v1/org/]({{navprefix}}/{{org-api}}#editOrg)`  
Edits the specified Org object.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**POST** /tspublic/v1/org/search]({{navprefix}}/{{org-api}}#getOrgs)`  
Gets all Org objects.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**DELETE** /tspublic/v1/org/]({{navprefix}}/{{org-api}}#deleteOrg)`  
Deletes an Org object.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |

## User management

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/user/]({{navprefix}}/{{user-api}}#create-user)`  
Creates a user account.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/user/activate]({{navprefix}}/{{user-api}}#activate-user)`  
Activates a user account.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**PUT** /tspublic/v1/user/{userid}]({{navprefix}}/{{user-api}}#update-user)`  
Modifies a user account.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**PUT** /tspublic/v1/user/email]({{navprefix}}/{{user-api}}#addEmail)`  
Modifies the email address of a user.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/user/addtoorg]({{navprefix}}/{{user-api}}#addOrg)`  
Adds one or several users to the specified Org.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**GET** /tspublic/v1/user/]({{navprefix}}/{{user-api}}#get-user-details)`  
Gets details of the users in a ThoughtSpot system.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**DELETE** /tspublic/v1/user/{userid}]({{navprefix}}/{{user-api}}#delete-user)`  
Deletes a user account.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/user/list]({{navprefix}}/{{user-api}}#user-list)`  
Gets all users, groups, and their inter-dependencies.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/user/updatepreference]({{navprefix}}/{{user-api}}#updatepreference-api)`  
Modifies a user profile.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/user/transfer/ownership]({{navprefix}}/{{user-api}}#transfer-ownership)`  
Transfers the ownership of objects from one user to another.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/user/updatepassword]({{navprefix}}/{{user-api}}#change-pwd)`  
Changes the password of a user account.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/user/resetpassword]({{navprefix}}/{{user-api}}#resetpassword)`  
Resets the password of a user account.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/user/session/invalidate]({{navprefix}}/{{user-api}}#invalidate-user-session)`  
Invalidates a user session.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/user/inactivate]({{navprefix}}/{{user-api}}#deactivate-user)`  
Deactivates a user account.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/user/sync]({{navprefix}}/{{user-api}}#user-sync)`  
Synchronizes user and group properties from an external database with the user data on ThoughtSpot.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/user/{userid}/groups]({{navprefix}}/{{user-api}}#assignUserToGroups)`  
Assigns a user to the specified user groups.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/user/{userid}/groups]({{navprefix}}/{{user-api}}#getGroupsUser)`  
Gets details of the user groups associated with a specific user.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**PUT** /tspublic/v1/user/{userid}/groups]({{navprefix}}/{{user-api}}#editGroupsforUser)`  
Updates the user group data for a specific user.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**DELETE** /tspublic/v1/user/{userid}/groups]({{navprefix}}/{{user-api}}#removeUserGroupAssoc)`  
Removes a user from the specified user groups.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |

## Groups and privileges

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/group/]({{navprefix}}/{{group-api}}#create-group)`  
Creates a user group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/group/]({{navprefix}}/{{group-api}}#get-ug-details)`  
Gets details of a user group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**PUT** /tspublic/v1/group/{groupid}]({{navprefix}}/{{group-api}}#update-group)`  
Modifies a user group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/group/{groupid}/user/{userid}]({{navprefix}}/{{group-api}}#add-user-to-group)`  
Assigns a user to a group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/group/listuser/{groupid}]({{navprefix}}/{{group-api}}#get-users-group)`  
Gets a list of users assigned to a group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/group/{groupid}/users]({{navprefix}}/{{group-api}}#addUserToGroup)`  
Adds users to a specific group.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**PUT** /tspublic/v1/group/{groupid}/users]({{navprefix}}/{{group-api}}#editusersInGroup)`  
Updates user data for a given group.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/group/{groupid}/users]({{navprefix}}/{{group-api}}#get-usersInGroup)`  
Gets details of the users that are currently assigned to a group.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**DELETE** /tspublic/v1/group/{groupid}/users]({{navprefix}}/{{group-api}}#deleteUsersInGroup)`  
Removes users from a group.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/group/addrole]({{navprefix}}/{{group-api}}#addRole)`  
Assigns a Role to a user group.

 | 

ThoughtSpot Cloud 9.7.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**POST** /tspublic/v1/group/addprivilege]({{navprefix}}/{{group-api}}#add-privilege)`  
Assigns a privilege to a user group.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/group/removerole]({{navprefix}}/{{group-api}}#removeRole)`  
Removes the Role assigned to a group.

 | 

ThoughtSpot Cloud 9.7.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**POST** /tspublic/v1/group/removeprivilege]({{navprefix}}/{{group-api}}#remove-privilege)`  
Removes privileges assigned to a user group.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/group/{groupid}/groups]({{navprefix}}/{{group-api}}#assign-group)`  
Assigns groups to a parent group.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**PUT** /tspublic/v1/group/{groupid}/groups]({{navprefix}}/{{group-api}}#modifySubgroup)`  
Updates subgroup objects for a given group.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/group/{groupid}/groups]({{navprefix}}/{{group-api}}#get-children)`  
Gets a list of subgroups for a given group object.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/group/addmemberships]({{navprefix}}/{{group-api}}#addMembers)`  
Adds members to a group.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/group/removememberships]({{navprefix}}/{{group-api}}#removeMembers)`  
Removes members from a group.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**DELETE** /tspublic/v1/group/{groupid}/groups]({{navprefix}}/{{group-api}}#del-child-groups)`  
Removes subgroups from a group.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**DELETE** /tspublic/v1/group/{groupid}/user/{userid}]({{navprefix}}/{{group-api}}#delete-user-assoc)`  
Removes a user from a user group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**DELETE** /tspublic/v1/group/{groupid}]({{navprefix}}/{{group-api}}#delete-group)`  
Deletes a user group.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |

## Roles

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /api/rest/2.0/roles/create]({{navprefix}}/{{roles-api}}#createRole)`  
Creates a Role.

 | 

ThoughtSpot Cloud 9.7.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**PUT** /tspublic/v1/role/{role_identifier}]({{navprefix}}/{{roles-api}}#editRole)`  
Edits the properties of a Role object.

 | 

ThoughtSpot Cloud 9.7.0.cl  
ThoughtSpot Software Not available

 |
| 

[`**POST** /tspublic/v1/role/search`]({{navprefix}}/{{roles-api}}#searchRole)  
Gets Role objects.

 | 

ThoughtSpot Cloud 9.7.0.cl  
ThoughtSpot Software Not available

 |
| 

[`**DELETE** /tspublic/v1/role/{role_identifier}`]({{navprefix}}/{{roles-api}}#deleteRole)  
Removes a Role object from ThoughtSpot.

 | 

ThoughtSpot Cloud 9.7.0.cl  
ThoughtSpot Software Not available

 |

## Session management

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/session/login]({{navprefix}}/{{session-api}}#session-login)`  
Signs in a user to ThoughtSpot.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/session/auth/token]({{navprefix}}/{{session-api}}#session-authToken)`  
Generates an authentication token for a user session.  
Use this API endpoint to obtain a token for trusted authentication.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 7.1.1





 |
| 

`[**GET** /tspublic/v1/session/login/token]({{navprefix}}/{{session-api}}#session-loginToken)` (Deprecated)  
Authenticates and logs in a user using a token obtained from the `/tspublic/v1/session/auth/token` API call.  
This request method sends authentication attributes as query string parameters in the request URL.  
_This API call is not required if you are using Visual Embed SDK_.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/session/login/token]({{navprefix}}/{{session-api}}#session-loginToken)`  
Authenticates and logs in a user using a token obtained from the `/tspublic/v1/session/auth/token` API call.  
This request method sends authentication attributes in the request body as `formData` parameters. For secure exchange of authentication information, we recommend using the `POST` request method.  
_This API call is not required if you are using Visual Embed SDK_.

 | 

ThoughtSpot Cloud ts8.nov.cl  
ThoughtSpot Software 7.2.1.sw

 |
| 

`[**POST** /tspublic/v1/session/logout]({{navprefix}}/{{session-api}}#session-logout)`  
Logs out a user from an existing session.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**GET** /tspublic/v1/session/info]({{navprefix}}/{{session-api}}#session-info)`  
Gets session information.

 | 

ThoughtSpot Cloud ts7.oct.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**PUT** /tspublic/v1/session/orgs]({{navprefix}}/{{session-api}}#orgSwitch)`  
Allows switching between organizations on a multi-tenant instance.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**GET** /tspublic/v1/session/orgs]({{navprefix}}/{{session-api}}#getOrgs)`  
Gets Orgs for the logged-in user.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**GET** /tspublic/v1/session/orgs/users/{userid}]({{navprefix}}/{{session-api}}#getOrgsForUser)`  
Gets Orgs for a specific user.

 | 

ThoughtSpot Cloud 8.10.0.cl  
ThoughtSpot Software Not available

 |
| 

`[**POST** /tspublic/v1/session/homepinboard]({{navprefix}}/{{session-api}}#set-home-liveboard)`  
Sets a specific Liveboard as a home Liveboard.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/session/homepinboard]({{navprefix}}/{{session-api}}#get-home-liveboard)`  
Returns the GUID of the Liveboard that is set as a home Liveboard for the currently logged-in user.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**DELETE** /tspublic/v1/session/homepinboard]({{navprefix}}/{{session-api}}#del-home-liveboard)`  
Removes the home Liveboard settings for the currently logged-in user.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |

## Metadata management

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/metadata/assigntag]({{navprefix}}/{{metadata-api}}#assign-tag)`  
Assigns tags to a metadata object, such as a Liveboard, search answer, table, worksheet, or view.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/metadata/unassigntag]({{navprefix}}/{{metadata-api}}#unassign-tags)`  
Removes tag associations to metadata objects.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/metadata/details]({{navprefix}}/{{metadata-api}}#metadata-details)`  
Gets metadata details for a specific data object such as a Liveboard, answer, or a worksheet.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/metadata/list]({{navprefix}}/{{metadata-api}}#metadata-list)`  
Gets a list of all metadata objects from the ThoughtSpot resource repository.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1  

_The authorguid attribute is available from ThoughtSpot Cloud ts8.nov.cl and ThoughtSpot Software 8.4.1-sw onwards._

 |
| 

`[**GET** /tspublic/v1/metadata/listas]({{navprefix}}/{{metadata-api}}#headers-metadata-users)`  
Gets a list of metadata objects that are available to a user or user group.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/metadata/listobjectheaders]({{navprefix}}/{{metadata-api}}#object-header)`  
Lists metadata object headers in the repository.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**GET** /tspublic/v1/metadata/listvizheaders]({{navprefix}}/{{metadata-api}}#viz-header)`  
Gets visualization headers from the ThoughtSpot system.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 6.0.x

 |
| 

`[**POST** /tspublic/v1/metadata/markunmarkfavoritefor]({{navprefix}}/{{metadata-api}}#set-favorite)`  
Adds objects to favorites for a given user account.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**DELETE** /tspublic/v1/metadata/markunmarkfavoritefor]({{navprefix}}/{{metadata-api}}#del-object-fav)`  
Removes the objects from a user’s favorites list.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/metadata/delete]({{navprefix}}/{{metadata-api}}#del-obj)`  
Deletes one or several metadata objects.

 | 

ThoughtSpot Cloud 9.0.0.cl  
ThoughtSpot Software 9.0.1.sw

 |

## Configuration management

 
| API endpoint | Available from |
| --- | --- |
| 
`[**GET** /tspublic/v1/admin/configinfo]({{navprefix}}/{{admin-api}}#get-configInfo)`  
Gets details of the current configuration of a ThoughtSpot cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/admin/configinfo]({{navprefix}}/{{admin-api}}#get-configInfo)`  
Gets details of the current configuration of a ThoughtSpot cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/admin/configinfo/update]({{navprefix}}/{{admin-api}}#configinfo-update)`  
Updates configuration settings of a ThoughtSpot cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/admin/configinfo/overrides]({{navprefix}}/{{admin-api}}#get-config-overrides)`  
Gets details of configuration overrides on the current ThoughtSpot cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/admin/embed/actions]({{navprefix}}/{{admin-api}}#get-embed-actions)`  
Gets details of the custom actions enabled on the cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/admin/embed/actions/{actionid}]({{navprefix}}/{{admin-api}}#get-action-by-id)`  
Gets details of a specific custom action.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/admin/embed/actions]({{navprefix}}/{{admin-api}}#create-custom-action)`  
Creates a custom action

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**PUT** /tspublic/v1/admin/embed/actions/{actionid}]({{navprefix}}/{{admin-api}}#edit-custom-action)`  
Modifies the attributes of a custom action.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**DELETE** /tspublic/v1/admin/embed/actions/{actionid}]({{navprefix}}/{{admin-api}}#del-custom-action)`  
Deletes a custom action.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/admin/embed/actions/{actionid}/associations]({{navprefix}}/{{admin-api}}#custom-action-assoc)`  
Associates a custom action to a ThoughtSpot object.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/admin/embed/actions/{actionid}/associations]({{navprefix}}/{{admin-api}}#get-custom-action-assoc)`  
Gets the details of the ThoughtSpot objects associated with a custom action.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**DELETE** /tspublic/v1/admin/embed/actions/{actionid}/associations]({{navprefix}}/{{admin-api}}#del-action-association)`  
Removes custom action associations.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |

## Data connections

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/connection/create]({{navprefix}}/{{connections-api}}#cre-connection)`  
Creates a data connection.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/connection/update]({{navprefix}}/{{connections-api}}#edit-connection)`  
Modifies a data connection.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/connection/types]({{navprefix}}/{{connections-api}}#connection-types)`  
Gets a list of data connections that are currently operational on the ThoughtSpot cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/connection/list]({{navprefix}}/{{connections-api}}#live-query-connections)`  
Gets a list of data connections set up for a live query service on the ThoughtSpot cluster.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/connection/fetchConnection]({{navprefix}}/{{connections-api}}#connMetadata)`  
Gets metadata for a given connection ID.

 | 

ThoughtSpot Cloud 8.2.0.cl  
ThoughtSpot Software 8.4.1-sw

 |
| 

`[**POST** /tspublic/v1/connection/fetchLiveColumns]({{navprefix}}/{{connections-api}}#fetchLiveColums)`  
Gets tables and column metadata a given connection ID.

 | 

ThoughtSpot Cloud 8.2.0.cl  
ThoughtSpot Software 8.4.1-sw

 |
| 

`[**GET** /tspublic/v1/connection/export]({{navprefix}}/{{connections-api}}#export-connections)`  
Exports a data connection map.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**POST** /tspublic/v1/connection/delete]({{navprefix}}/{{connections-api}}#del-connection)`  
Deletes the specified data connections.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |

## TML objects

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/metadata/tml/import]({{navprefix}}/{{tml-api}}#import)`  
Imports object representations in the ThoughtSpot Modeling Language (TML) format.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/metadata/tml/export]({{navprefix}}/{{tml-api}}#export)`  
Exports objects from ThoughtSpot as TML representations.

 | 

ThoughtSpot Cloud ts7.may.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/metadata/tml/export/batch]({{navprefix}}/{{tml-api}}#export)`  
Exports user, user group, and Role objects in TML format.

 | 

ThoughtSpot Cloud 10.1.0.cl  
ThoughtSpot Software 10.1.0.sw

 |

## Liveboard data

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/export/pinboard/pdf]({{navprefix}}/{{pinboard-export-api}})`  
Downloads a Liveboard or specific visualizations from a Liveboard as a PDF file.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/pinboarddata]({{navprefix}}/{{pinboarddata}})`  
Gets Liveboard object data from the ThoughtSpot application.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |

## Search data

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/searchdata]({{navprefix}}/{{search-data-api}}#search-data-api-ref)`  
Allows searching for data from a specific data source in the ThoughtSpot application.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software 6.0.x

 |

## Dependent objects

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/dependency/listdependents]({{navprefix}}/{{dependency-apis}}#add-dependents)`  
Gets a list of dependents for a given data object type.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/dependency/logicalcolumn]({{navprefix}}/{{dependency-apis}}#get-column-dependents)`  
Gets a list of dependent objects for a logical column.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/dependency/logicaltable]({{navprefix}}/{{dependency-apis}}#get-table-dependents)`  
Gets a list of dependent objects for data objects such as worksheets, tables, or views.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/dependency/logicalrelationship]({{navprefix}}/{{dependency-apis}}#get-dependents-joins)`  
Gets a list of dependent objects for table joins.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/dependency/physicalcolumn]({{navprefix}}/{{dependency-apis}}#get-dependents-phycolumn)`  
Gets a list of dependent objects for a physical column.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/dependency/physicaltable]({{navprefix}}/{{dependency-apis}}#get-dependents-phytable)`  
Gets a list of dependent objects for a physical table.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/dependency/pinboard]({{navprefix}}/{{dependency-apis}}#get-dependent-liveboard)`  
Gets a list of dependent object headers for a Liveboard.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/dependency/listincomplete]({{navprefix}}/{{dependency-apis}}#get-incomplete-objects)`  
Gets a list of objects with incomplete metadata.

 | 

ThoughtSpot Cloud ts7.aug.cl  
ThoughtSpot Software 7.2.1

 |

## Security

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/security/share]({{navprefix}}/{{security-api}}#share-object)`  
Shares ThoughtSpot objects with another user or user group.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**POST** /tspublic/v1/security/shareviz]({{navprefix}}/{{security-api}}#shareviz)`  
Shares a specific visualization with another user or user group.

 | 

ThoughtSpot Cloud ts7.jun.cl  
ThoughtSpot Software 7.1.1

 |
| 

`[**GET** /tspublic/v1/security/metadata/permissions]({{navprefix}}/{{security-api}}#obj-permission-all)`  
Gets object permission details for a specific object type.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/security/metadata/{id}/permissions]({{navprefix}}/{{security-api}}#obj-permission-id)`  
Gets object permission details for a specific object ID.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |
| 

`[**GET** /tspublic/v1/security/effectivepermissionbulk]({{navprefix}}/{{security-api}}#get-obj-perm-bulk)`  
Gets object permission details for multiple object types and IDs.

 | 

ThoughtSpot Cloud ts7.sep.cl  
ThoughtSpot Software 7.2.1

 |

## Audit logs

 
| API endpoint | Available from |
| --- | --- |
| 
`[**GET** /tspublic/v1/logs/topics/{topic}]({{navprefix}}/{{logs-api}})`  
Gets security audit logs from the ThoughtSpot system.

 | 

ThoughtSpot Cloud ts7.april.cl  
ThoughtSpot Software Not applicable

 |

## Materialization service

 
| API endpoint | Available from |
| --- | --- |
| 
`[**POST** /tspublic/v1/materialization/refreshview/{id}]({{navprefix}}/{{materialization-api}})`  
Allows you refresh a materialized view.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.0.x

 |

## Database and schema

 
| API endpoint | Available from |
| --- | --- |
| 
`[**GET** /tspublic/v1/database/tables]({{navprefix}}/{{database-api}}#list-tables)`  
Gets a list of all tables in a database and schema in Falcon.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.3.1

 |
| 

`[**GET** /tspublic/v1/database/schemas]({{navprefix}}/{{database-api}}#list-schemas)`  
Gets a list of all schemas in a particular database in Falcon.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.3.1

 |
| 

`[**GET** /tspublic/v1/database/databases]({{navprefix}}/{{database-api}}#list-database)`  
Gets a list of all databases in Falcon.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.3.1

 |
| 

`[**GET** /tspublic/v1/database/getTableDetail]({{navprefix}}/{{database-api}}#table-detail)`  
Gets details of a particular table.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.3.1

 |
| 

`[**POST** /tspublic/v1/database/createtable]({{navprefix}}/{{database-api}}#create-table)`  
Creates tables in a database.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.3.1

 |
| 

`[**POST** /tspublic/v1/database/run]({{navprefix}}/{{database-api}}#run-tql)`  
Runs TQL commands with SQL statements.

 | 

ThoughtSpot Cloud Not applicable  
ThoughtSpot Software 6.3.1

 |