ThoughtSpot provides several REST APIs to manage users, sessions, ThoughtSpot data objects.

Use the following REST APIs to programmatically manage ThoughtSpot users, user groups, sessions, and data objects.

To access REST APIs, you must authenticate through SAML SSO. For more information on configuring SAML, see SAML SSO.

API Service Request URLs Description
User POST /tspublic/v1/user/transfer/ownership Transfer ownership of all objects from one user to another.
POST /tspublic/v1/user/sync Synchronize principal from your external system with ThoughtSpot.
POST /tspublic/v1/user/updatepassword Change the password of a user.
GET /tspublic/v1/user/list Get all users, groups and their inter-dependencies.
Group POST /tspublic/v1/group/addprivilege Add a privilege to a group.
POST /tspublic/v1/group/removeprivilege Remove a privilege from a group.
Session POST /tspublic/v1/session/login Authenticate and log in a user.
POST /tspublic/v1/session/logout Log out a user from an existing session.
POST /tspublic/v1/session/auth/token Obtain an authentication token for a user.
Pinboard Data POST /tspublic/v1/pinboarddata Get the pinboard data from the ThoughtSpot system.
Pinboard Export POST /tspublic/v1/export/pinboard/pdf Export a pinboard or the visualizations in a pinboard as a PDF file.
Metadata GET /tspublic/v1/metadata/listobjectheaders List the metadata object headers in the repository.
GET /tspublic/v1/metadata/listvizheaders Get the visualization headers from the ThoughtSpot system.
Search Data POST /tspublic/v1/searchdata Search data from a specific data source in the ThoughtSpot system.
TML POST /tspublic/v1/metadata/tml/import Validate and import TML objects.
POST /tspublic/v1/metadata/tml/export Export TML objects.