Tableau REST API

https://help.tableau.com/current/api/rest_api/en-us/
Admin
The Tableau REST API enables programmatic management and modification of Tableau Server, Tableau...
Tokens:935,750
Snippets:6,600
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Server Schedule Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example XML response body for a successful Get Server Schedule request.

```xml
<tsResponse version-and-namespace-settings>
   <schedule id="60456a5c-0293-4fed-9391-6d94a5f42b48"
	name="My Schedule"
	state="Active"
	priority="50"
	createdAt="2020-02-24T22:18:20Z"
	updatedAt="2020-02-24T22:18:20Z"
	type="Extract"
	frequency="Monthly"
	nextRunAt="2020-02-25T19:20:00Z"
	executionOrder="Parallel">
	   <frequencyDetails start="11:20:00">
		<intervals>
		   <interval monthDay="Customized Monthly"/>
		</intervals>
	   </frequencyDetails>
   </schedule>
</tsResponse>
```

--------------------------------

### Get View Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A concrete example of an XML response body returned by the Get View method.

```xml
<tsResponse>
  <view id="57dc5674-23aa-4a83-b3d4-8653cf3c735f"
	name="Sheet 1"
	contentUrl="workbook/sheets/Sheet1"
	createdAt="2019-05-07T17:59:42Z"
	updatedAt="2019-05-07T17:59:48Z"
	viewUrlName="view-name">
	  <workbook id="0cee459c-9640-4d10-a33d-c6ee98b72beb"/>
	  <owner id="1b526a10-048b-4d1d-96e7-e12ec7f46388"/>
	  <project id="0ef6e0e6-b775-4d0c-8a1c-1b82e6343526"/>
	  <tags/>
  </view>
</tsResponse>
```

--------------------------------

### Get Favorites Request and Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A cURL request example and the corresponding successful XML response.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/favorites/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

```xml
<tsResponse version-and-namespace-settings>
  <favorites>
    <favorite label="Global Economic Indicators">
	  <view id="796c9371-a180-46b7-9970-feffe8573d47"
		name="Overview"
		contentUrl="Superstore/sheets/Overview"
		createdAt="2015-11-09T21:39:59Z"
		updatedAt="2019-08-30T21:05:37Z"
		viewUrlName="Overview" >
		  <workbook id="65e18031-b2f0-4ab6-994b-2c5520b830bb"/>
		  <owner id="abb3e4c1-e650-4704-870a-03fb7615136f"/>
		  <project id="3d6e8174-8cdf-43ec-94dd-0a1fd3662e47"/>
		  <tags/>
	  </view>
	</favorite>
  </favorites>
</tsResponse>
```

--------------------------------

### Get Recommendations Request and Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example cURL request and the corresponding XML response body.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/recommendations?type=view" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

```xml
<tsRequest>
 <recommendations>
   <recommendation score="94.100233876">
     <view id="0f0d33ac-027d-42a7-94bf-4f0b13e07652" />
     <similarUsersExplanation>
       <users>
         <user id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" />
         <user id="f33n9d9c-8b8a-8f8e-7d7c-7b7a6f6d0p12" />
       </users>
     </similarUsersExplanation>
   </recommendation>
   <recommendation score="94.038491833">
     <view id="w33533ac-027d-42a7-94bf-4f0b13e0so32" />
     <popularExplanation />
   </recommendation>
 </recommendations>
</tsRequest>
```

--------------------------------

### Get Server Schedule Request Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example cURL command to retrieve a specific server schedule.

```bash
curl "http://MY-SERVER/api/3.29/schedules/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

--------------------------------

### Get Flow Run Tasks Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

An example XML response containing a list of scheduled flow tasks.

```xml
<tsResponse version-and-namespace-settings>
    <tasks>
        <task>
            <flowRun id="1bff10bb-57ae-43df-8774-a86d14aef432" priority="50" consecutiveFailedCount="2" type="RunFlowTask">
                <schedule id="36d6fab2-2a0a-432e-b464-9fe4229a9937" name="Every 2 Minutes - Only use for failing (to be suspended) flows!" state="Active" priority="50" createdAt="2018-11-08T21:57:49Z" updatedAt="2018-11-09T17:30:08Z" type="Flow" frequency="Hourly" nextRunAt="2018-11-09T17:32:00Z"/>
                <flow id="8a320dca-9151-41ea-8474-a0bb71961cc0" name="allUseCaseTFLX2"/>
		 <parameters>
			<parameter id="ebfad780-c19f-42a2-822a-406468269a02" type="string" name="Region" description="" value="North" isRequired="false">
			<domain xsi:type="flowParameterListDomainType" domainType="any">
			</domain>
			</parameter>
	     </parameters>
            </flowRun>
        </task>
        <task>
            <flowRun id="f11741cb-9646-4fb8-bbac-6d099c8d56b9" priority="50" consecutiveFailedCount="2" type="RunFlowTask">
                <schedule id="36d6fab2-2a0a-432e-b464-9fe4229a9937" name="Every 2 Minutes - Only use for failing (to be suspended) flows!" state="Active" priority="50" createdAt="2018-11-08T21:57:49Z" updatedAt="2018-11-09T17:30:08Z" type="Flow" frequency="Hourly" nextRunAt="2018-11-09T17:32:00Z"/>
                <flow id="8a320dca-9151-41ea-8474-a0bb71961cc0" name="allUseCaseTFLX2"/>
		 <flowParameterSpecs/>
            </flowRun>
        </task>
        <task>
            <flowRun id="357aaf2b-758d-4feb-a447-822528635a67" priority="44" consecutiveFailedCount="2" type="RunFlowTask">
                <schedule id="6d4e61d0-2e2f-4f48-abc8-0695b95a5287" name="Every 15 mins!" state="Active" priority="50" createdAt="2018-11-08T20:45:47Z" updatedAt="2018-11-09T17:30:08Z" type="Flow" frequency="Hourly" nextRunAt="2018-11-09T17:45:00Z"/>
                <flow id="d00700fe-28a0-4ece-a7af-5543ddf38a82" name="SQLServerUserNamePassword Good"/>
		 <flowParameterSpecs/>
            </flowRun>
        </task>
   </tasks>
</tsResponse>
```

--------------------------------

### Get Metric Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

An example of the XML response body returned for a specific metric query.

```xml
<tsResponse>
  <metric id="6561daa3-20e8-407f-ba09-709b178c0b4a"
    name="my metric name"
    description="Description of my metric."
    webpageUrl="https://MY-SERVER/#/site/site-name/metrics/site-num"
    createdAt="2020-01-02T01:02:03Zd"
    updatedAt="2020-01-02T01:02:03Z"
    suspended="true">
      <project id="32e79edb-6cfd-47dc-ad79-e8ec2fbb1d33"
        name="my project name"/>
      <owner id="32e79edb-6cfd-47dc-ad79-e8ec2fbb1d33"/>
      <tags/>
      <underlyingView id="29dae0cd-1862-4a20-a638-e2c2dfa682d4"/>
  </metric>
</tsResponse>
```

--------------------------------

### List SCIM Configurations cURL Request

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example request to retrieve SCIM configurations using the GET method.

```bash
GET request: curl --location 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations'
```

--------------------------------

### cURL Request Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example of a cURL request to retrieve datasource connections.

```bash
curl http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

--------------------------------

### Add Project to Favorites cURL Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A cURL command example demonstrating how to perform the PUT request.

```bash
curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/favorites/2474164d-8d37-4a4c-abc7-c2070fd25fd5" -X PUT -d @add-project-to-favorites.xml -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

--------------------------------

### Add Project to Favorites Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

The XML response returned for the provided cURL example.

```xml
<tsResponse version-and-namespace-settings>
  <favorites>
    <favorite label="Economic Indicators">
      <project id="1f1e1d1c2-b2a2-f2e3-d3c3-b3a4f4e4d4c"/>
    </favorite>
  </favorites>
</tsResponse>
```

--------------------------------

### Switch Site cURL Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A cURL command example for switching sites using a request body file.

```bash
curl "https://MY-SERVER/api/3.29/auth/switchSite" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"-d @switch_site.xml
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A sample XML response showing various notification preferences for email, in_app, and slack channels.

```xml
<tsResponse>
  <userNotificationsPreferences>
    <userNotificationsPreference channel="email"
      notificationType="comments"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="email"
      notificationType="webhooks"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="email"
      notificationType="prepflow" enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="email"
      notificationType="share"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="email"
      notificationType="dataalerts"
      enabled="true"
      disabledByOverride="true"/>
    <userNotificationsPreference channel="email"
      notificationType="extractrefresh"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="in_app"
      notificationType="comments"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="in_app"
      notificationType="prepflow"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="in_app"
      notificationType="share"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="in_app"
      notificationType="extractrefresh"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="slack"
      notificationType="comments"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="slack"
      notificationType="prepflow"
      enabled="true"
      disabledByOverride="false"/>
    <userNotificationsPreference channel="slack"
      notificationType="share"
      enabled="true"
      disabledByOverride="false"/>
     <userNotificationsPreference channel="slack"
      notificationType="dataalerts"
      enabled="true"
      disabledByOverride="false"/>
  </userNotificationsPreferences>
</tsResponse>
```

--------------------------------

### Query Sites Request and Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example cURL request and the corresponding XML response for querying sites.

```bash
curl "http://MY-SERVER/api/3.29/sites?pageSize=1&pageNumber=1" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

```xml
<tsResponse>
  <pagination pageNumber="1"
    pageSize="1"
    totalAvailable="2"/>
  <sites>
    <site id="abcd1234-ab12-ab12-ab12-abcd1234abcd"
    name="Default"
    contentUrl=""
    adminMode="ContentAndUsers"
    disableSubscriptions="true"
    state="Active"
    revisionHistoryEnabled="true"
    revisionLimit="25"
    subscribeOthersEnabled="false"
    allowSubscriptionAttachments="true"
    guestAccessEnabled="true"
    cacheWarmupEnabled="true" [REMOVED IN API 3.19]
    commentingEnabled="true"
    editingFlowsEnabled="false"
    schedulingFlowsEnabled="false"
    extractEncryptionMode="enabled"
    catalogingEnabled="true"
    derivedPermissionsEnabled="false"
    requestAccessEnabled ="false"
    runNowEnabled="true"
    isDataAlertsEnabled="true"
    askDataMode="DisabledByDefault"
    useDefaultTimeZone="false"
    timeZone="America/Los_Angeles"
    explainDataEnabled="true"
    dqwSubscriptionsEnabled="false" />
  </sites>
</tsResponse>
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Sample XML response containing a list of schedules.

```xml
<tsResponse _version-and-namespace-settings_ >
   <pagination pageNumber="1" pageSize="100" totalAvailable="3" />
   <schedules>
	<schedule id="ca3ce4f5-666c-4bb8-a763-5df24783881f"
	   name="Hourly"
	   state="Active"
	   priority="50"
	   createdAt="2011-03-30T22:32:35Z"
	   updatedAt="2016-01-13T01:00:02Z"
	   type="Extract"
	   frequency="Hourly"
	   nextRunAt="2016-01-13T23:00:00Z" />
	<schedule id="13abd238-0b22-4789-bcc4-614d31908310"
	   name="Saturday night"
	   state="Active"
	   priority="50"
	   createdAt="2010-10-28T21:11:33Z"
	   updatedAt="2016-01-10T07:00:00Z"
	   type="Extract"
	   frequency="Weekly"
	   nextRunAt="2016-01-17T07:00:00Z" />
	<schedule id="b6a6d11a-9e20-49f1-9b74-693f196b9aca"
	   name="End of the month"
	   state="Suspended"
	   priority="50"
	   createdAt="2010-10-28T21:11:33Z"
	   updatedAt="2016-01-01T07:00:03Z"
	   type="Extract"
	   frequency="Monthly"
	   nextRunAt="2016-02-01T07:00:00Z" />
   </schedules>
</tsResponse>
```

--------------------------------

### Get SCIM Configuration cURL Request

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example of a GET request to retrieve a specific SCIM configuration using cURL.

```bash
GET request: curl --location 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations/065693d8-436a-4738-a8f1-375953a2a888'
```

--------------------------------

### Example Response for Job Creation

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A sample response body showing a job creation status.

```xml
<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-2.8.xsd">
  <job id="20cf4ddc-6d73-4733-89ec-8d336669bd56" mode="Asynchronous" type="RefreshExtract" createdAt="2017-12-06T22:58:52Z">
    <extractRefreshJob>
      <datasource id="89a82d78-664f-45a1-8256-d4d2961a070b" name="World Indicators Extract" />
    </extractRefreshJob>
  </job>
</tsResponse>
```

--------------------------------

### Get Custom View Response Formats

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example XML and JSON response bodies for the Get Custom View operation.

```xml
<tsResponse >
  <pagination pageNumber="1" pageSize="100" totalAvailable="1673"/>
  <customView
    id="37d015c6-bc28-4c88-989c-72c0a171f7aa"
    name="New name 2"
    createdAt="2016-02-03T23:35:09Z"
    updatedAt="2022-09-28T23:56:01Z"
    lastAccessedAt="2022-09-28T23:57:12Z"
    shared="false">
      <view id="8e33ff19-a7a4-4aa5-9dd8-a171e2b9c29f" name="circle"/>
      <workbook id="2fbe87c9-a7d8-45bf-b2b3-877a26ec9af5" name="marks and viz types 2"/>
      <owner id="cdfe8548-84c8-418e-9b33-2c0728b2398a" name="workgroupuser"/>
  </customView>
</tsResponse>
```

```json
{
  "pagination": {
	"pageNumber": "1",
	"pageSize": "100",
	"totalAvailable": "1673"
  },
  "customView": {
	"id": "37d015c6-bc28-4c88-989c-72c0a171f7aa",
	"name": "New name 2",
	"createdAt": "2016-02-03T23:35:09Z",
	"updatedAt": "2022-09-28T23:56:01Z",
	"lastAccessedAt": "2022-09-28T23:57:12Z",
	"shared": "false",
	"view": {
	  "id": "8e33ff19-a7a4-4aa5-9dd8-a171e2b9c29f",
	  "name": "circle"
	},
  	"workbook": {
	  "id": "2fbe87c9-a7d8-45bf-b2b3-877a26ec9af5",
	  "name": "marks and viz types 2"
	},
	"owner": {
	  "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a",
	  "name": "workgroupuser"
    }
  }
}
```

--------------------------------

### Get Linked Task Request and Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example cURL command to retrieve a linked task and the corresponding XML response.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/tasks/linked/1bff10bd-57ae-37df-8774-a86d14aef432" -X GET -H "X-Tableau-Auth:12ab34cd56ef98ab90ce12ef34ab52cd"
```

```xml

<tsResponse version-and-namespace-settings>
    <linkedTasks id="18d267af-4c40-4dz6-8234-6ag8c3dea67f"
      numSteps="2">
       <schedule id="3ee04ae9-4dbf-45b5-a6d6-18fa19f2jb8a"
        name="Run Flow - Every Sunday - 4:00PM"
        state="Active" priority="50"
        createdAt="2021-01-21T19:15:53Z"
        updatedAt="2022-02-27T16:00:59Z"
        type="Flow" frequency="Weekly"
        nextRunAt="2022-03-06T16:00:00Z"/>
       <linkedTaskSteps>
         <linkedTaskSteps id="738fffc7-6a21-4af5-b49e-2c47f51480d2"
          stepNumber="1"
          stopDownstreamTasksOnFailure="true">
           <task>
             <flowRun id="690c3b2c-a309-4683-9e6e-166517dc8598"
              priority="50"
              consecutiveFailedCount="0"
              type="RunFlowTask">
               <flow id="56809d67-aca9-4f08-9fdc-4b6473c3ff02" name="r-3"/>
             </flowRun>
           </task>
         </linkedTaskSteps>
</tsResponse>
```

--------------------------------

### Example Response for Connected App Query

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Sample XML response returned when successfully querying a connected app.

```xml
<tsResponse>
  <connectedApplications>
	<connectedApplication>
	  <secret>
		<id>7ecc5c7c-d923-4ffd-917b-cab1bd89f03b</id>
		<createdAt>2021-08-10T18:48:40Z</createdAt>
	  </secret>
	  <name>ConnectedApp_MyCo</name>
	  <enabled>true</enabled>
	  <clientId>ac95d175-c844-4779-9d58-415e01fe7dab</clientId>
	  <projectIds>
		<projectId>1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e</projectId>
		<projectId>1234de4e-5d6d-7c8c-9b0b-1a2a3f4f5e0e</projectId>
	  </projectIds>
	  <createdAt>2021-08-10T18:46:30Z</createdAt>
	  <unrestrictedEmbedding>false</unrestrictedEmbedding>
	</connectedApplication>
  <connectedApplications>
</tsResponse>
```

--------------------------------

### List View Permissions Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example cURL request and corresponding XML response for retrieving view permissions.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views/0524c7ce-250b-45b1-adf2-d08f1648643c/permissions" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

```xml
<tsResponse>
  <permissions>
    <view id="0524c7ce-250b-45b1-adf2-d08f1648643c"/>
      <owner id="1a5dffe8-2439-4862-9eb0-46d055ef7379"/>
    </view>
    <granteeCapabilities>
      <group id="9e617a5c-a733-11e8-8ec3-b748ab3bf3d6"/>
      <capabilities>
        <capability name="ViewComments" mode=mode="Allow"/>
        <capability name="ExportData" mode=mode="Allow"/>
        <capability name="AddComment" mode=mode="Allow"/>
        <capability name="Filter" mode=mode="Allow"/>
        <capability name="ViewUnderlyingData" mode=mode="Allow"/>
        <capability name="Read" mode=mode="Allow"/>
        <capability name="ShareView" mode=mode="Allow"/>
        <capability name="ExportImage" mode=mode="Allow"/>
      </capabilities>
      </granteeCapabilities>
    <granteeCapabilities>
      <user id="1a5dffe8-2439-4862-9eb0-46d055ef7379"/>
      <capabilities>
        <capability name="ExportImage" mode=mode="Allow"/>
        <capability name="AddComment" mode=mode="Allow"/>
      </capabilities>
    </granteeCapabilities>
    <granteeCapabilities>
      <user id="ff43cb47-f208-4d2f-9a22-0fbb6d29f7f1"/>
      <capabilities>
        <capability name="AddComment" mode=mode="Allow"/>
      </capabilities>
    </granteeCapabilities>
  </permissions>
</tsResponse>
```

--------------------------------

### Get Flow Run Task Request Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A cURL command example to retrieve information about a specific flow run task.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/tasks/runFlow/1bff10bb-57ae-43df-8774-a86d14aef432" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

--------------------------------

### List SCIM Configurations Response Formats

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example response bodies in XML and JSON formats.

```xml
<tsResponse>
  <scimConfigurations>
    <scimConfiguration>
    <id>3400f62c-7569-4608-89c9-98c4194390ee</id>
    <idpConfigurationId>cf73f5a0-8483-42f8-89ac-91a5aeed0bcc</idpConfigurationId>
    <isApiTokenActive>true</isApiTokenActive>
    <isOwner>true</isOwner>
    <name>SCIM Employees</name>
    <createdAt>2025-08-09 15:15:02.100</createdAt>
  </scimConfiguration>
  <scimConfiguration>
    <id>065693d8-436a-4738-a8f1-375953a2a888</id>
    <idpConfigurationId>95dcdf3b-30eb-42ae-b938-7ffca3e11fdc</idpConfigurationId>
    <isApiTokenActive>false</isApiTokenActive>
    <isOwner>false</isOwner>
    <name>SCIM Contractors</name>
    <createdAt>2025-03-27 11:07:49.129</createdAt>
    </scimConfiguration>
  </scimConfigurations>
<tsResponse>
```

```json
{
  "scimConfigurations": {
    "scimConfiguration": [
    {
      "id": "3400f62c-7569-4608-89c9-98c4194390ee",
      "idpConfigurationId": "cf73f5a0-8483-42f8-89ac-91a5aeed0bcc",
      "isApiTokenActive": true,
      "isOwner": true,
      "name": "SCIM Employees",
      "createdAt": "2025-08-09 15:15:02.100"
    },
    {
      "id": "065693d8-436a-4738-a8f1-375953a2a888",
      "idpConfigurationId": "95dcdf3b-30eb-42ae-b938-7ffca3e11fdc",
      "isApiTokenActive": false,
      "isOwner": false,
      "name": "SCIM Contractors",
      "createdAt": "2025-03-27 11:07:49.129"
     }
   ]
 }
}
```

--------------------------------

### Get Group Set Response Formats

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example XML and JSON response bodies returned by the Get Group Set endpoint.

```xml
<tsResponse version-and-namespace-settings>  
  <groupSet id="8cf3b6c1-839f-4eae-b41f-2144165193f2" name="All Users" groupCount="2">  
    <group id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d"    
      name="All Users" >  
    </group>  
    <group id="4123e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6234"  
      name="Researchers" >  
    </group>  
  </groupSet>  
</tsResponse>
```

```json
{  
  "groupSet": {  
    "id": "8cf3b6c1-839f-4eae-b41f-2144165193f2",  
    "name": "All Users",  
    "groupCount": "2",  
    "group": [  
      {  
        "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d",  
        "name": "All Users"  
      },  
      {  
        "id": "4123e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6234",  
        "name": "Researchers"  
      }  
    ]  
  }  
}
```

--------------------------------

### Add View to Favorites Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

The XML response returned after executing the example request.

```xml
<tsResponse version-and-namespace-settings>
  <favorites>
    <favorite label="DC Crimespotting">
	  <view id="08a7b6b5-b4ba-be3a-4d2d-1e9e59a8a7b6" name="Crimes_DC"
		contentUrl="content-url"
		createdAt="created-at"
		updatedAt="updated-at"
		viewUrlName="view-url-name">
		  <workbook id="abb3e4c1-e650-4704-870a-03fb7615136f"/>
		  <project id"3d6e8174-8cdf-43ec-94dd-0a1fd3662e47"/>
		  <tags />
	  </view>
    </favorite>
    <favorite label="Economic Indicators">
      <view id="1f1e1d1c2-b2a2-f2e3-d3c3-b3a4f4e4d4c"/>
    </favorite>
  </favorites>
</tsResponse>
```

--------------------------------

### Get Flow Run Task Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

An example of the XML response body returned for a successful flow run task request.

```xml
<tsResponse version-and-namespace-settings>
    <task>
        <flowRun id="1bff10bb-57ae-43df-8774-a86d14aef432" priority="50" consecutiveFailedCount="2" type="RunFlowTask">
            <schedule id="36d6fab2-2a0a-432e-b464-9fe4229a9937" name="Every 2 Minutes - Only use for failing (to be suspended) flows!" state="Active" priority="50" createdAt="2018-11-08T21:57:49Z" updatedAt="2018-11-09T18:12:09Z" type="Flow" frequency="Hourly" nextRunAt="2018-11-09T18:14:00Z"/>
            <flow id="8a320dca-9151-41ea-8474-a0bb71961cc0" name="allUseCaseTFLX2"/>
	     <parameters>
		<parameter id="ebfad780-c19f-42a2-822a-406468269a02" type="string" name="Region" description="" value="North" isRequired="false">
		<domain xsi:type="flowParameterListDomainType" domainType="any">
		</domain>
		</parameter>
	     </parameters>
        </flowRun>
    </task>
</tsResponse>
```

--------------------------------

### Get View cURL Request

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example of a GET request to retrieve view details using cURL, requiring an authentication token in the header.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6ds" -X GET -H "X-Tableau-Auth:RDEj_zqgQtGGcCiD3BXnSA|abXWv8thv5ocrXLNU7axCicQu3UdfgeX"
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A sample XML response showing a list of data connections for a workbook.

```xml
<tsResponse version-and-namespace-settings>
  <connections>
    <connection id="12ab34cd-56ef-78ab-90cd-12ef34ab56cd" type="dataengine" />
    <connection id="9a8a7b6b-5c4c-3d2d-1e0e-9a8a7b6b5b4b" type="dataengine" />
    <connection id="7b6b59a8-ac3c-4d1d-2e9e-0b5b4ba8a7b6" type="dataengine" />
    <connection id="374371c0-ffe9-4e16-b48e-6b868e3026ca" type="dataengine" />
    <connection id="08a7b6b5-b4ba-be3a-4d2d-1e9e59a8a7b6" type="dataengine" />
  </connections>
</tsResponse>
```

--------------------------------

### Get Personal Space cURL Request

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example request to retrieve personal space details using the GET method and authentication token.

```bash
curl "http://MY-SERVER/api/3.29/sites/7bfb590b-cfa7-4576-8bea-e9cc035/personalSpace -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

--------------------------------

### Define Frequency Details

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example of specifying start and end times for a scheduled job.

```XML
<frequencyDetail start="20:45:00" end="21:45:00">
  . . .
</frequencyDetail>
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

The XML response received after successfully adding the workbook to the schedule.

```xml
<tsResponse>
  <task>
    <extractRefresh id="9bf8aea0-e3ca-422e-b7ef-d9c4ba6cca45" priority="50" consecutiveFailedCount="0" type="RefreshExtractTask">
      <schedule id="9a4ebbab-9ec8-487a-9b48-47fa81d6077a" name="Weekday early mornings" state="Active" />
      <workbook id="5de9cc53-b17d-45af-804d-49144b39f29f" />
    </extractRefresh>
  </task>
</tsResponse>
```

--------------------------------

### Example EAS Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

The XML structure returned upon a successful GET request for an EAS.

```xml
<tsResponse>
   <externalAuthorizationServerList>
	<externalAuthorizationServer>
	   <name>EAS_1</name>
	   <id>7ecc5c7c-d923-4ffd-917b-cab1bd89f03b</id>
	   <issuerUrl>https://dev-57741098.okta.com/oauth2/aus3gd9kw7ixSfBKC5d7</issuerUrl>
	   <createdAt>2022-04-07T03:50:34Z</createdAt>
	</externalAuthorizationServer>
   <externalAuthorizationServerList>
</tsResponse>
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A sample XML response containing a list of views for a workbook.

```xml
<tsResponse version-and-namespace-settings>
  <views>
    <view id="1f1e1d1c-2b2a-2f2e-3d3c-3b3a4f4e4d4c" name="Tale of 100 Start-ups"
          contentUrl="Finance/sheets/Taleof100Start-ups"/>
    <view id="9a8a7b6b-5c4c-3d2d-1e0e-9a8a7b6b5b4b" name="Economic Indicators"
          contentUrl="Finance/sheets/EconomicIndicators"/>
    <view id="7b6b59a8-ac3c-4d1d-2e9e-0b5b4ba8a7b6" name="Investing in the Dow"
          contentUrl="Finance/sheets/InvestingintheDow"/>
  </views>
</tsResponse>
```

--------------------------------

### Query User Response Example

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

An example XML response returned after a successful user query.

```xml
<tsResponse version-and-namespace-settings>
  <user id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" name="Alan"
    siteRole="ExplorerCanPublish"
    fullName="Alan Wang"
    authSetting="ServerDefault"
    lastLogin="2015-01-05T03:24:36Z"
	language="en-GB"
	locale="GB"
	idpConfigurationId="00000000-0000-0000-0000-0000000000" />
</tsResponse>
```

--------------------------------

### Get User Groups Request

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example cURL command to retrieve groups for a specific user.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/groups" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A sample XML response body showing recently viewed views and workbooks.

```xml
<tsResponse >
  <recents>
    <recent>
      <view
	    id="8a922e79-3041-4916-942e-1a18162ef8a9"
	    name="MySQL PostgresSQL"
	    contentUrl="my_site1"
	    createdAt="2019-01-28T20:33:35Z"
	    updatedAt="2019-01-28T20:44:05Z"
		viewUrlName="MySQL_PostgresSQL">
		  <workbook id="1eb0d238-c9d2-49ec-a0ce-762ddc6f9827"/>
		  <owner id="2dbbee8a-202c-4a74-82d6-8e3544f55ceb"/>
		  <project id="50b87b02-74b6-11e8-a4b0-df15be81c0c4"/>
		  <tags/>
      </view>
    </recent>
    <recent>
	  <workbook
	    id="5589cf2b-8601-43f9-9151-0f6c2db760cc"
	    name="Connections-AmazonAurora (1)"
	    description=""
	    contentUrl="my_site2"
	    webpageUrl="https://my_server/#/workbooks/222"
	    showTabs="false"
	    size="7"
	    createdAt="2019-02-13T20:52:37Z"
	    updatedAt="2019-02-13T20:52:38Z"
	    encryptExtracts="false"
	    defaultViewId="d4bed763-1cb1-4924-b455-6a6c298d860d">
	      <project id="add6c395-11b8-4d57-a66b-733220a33aa0" name="project2"/>
	      <owner id="3f90c20d-069f-46dd-b5a0-6e7092140790" name="my_name"/>
	      <tags/>
	  </workbook>
    </recent>
    <!--  more recently viewed views and workbooks  --%gt;
  </recent>
</tsResponse>
```

--------------------------------

### cURL Request for Virtual Connections

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example of a GET request to retrieve virtual connections using cURL.

```bash
curl --location --request GET "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections" \ --header "X-Tableau-Auth: 3bl3fJb0T6qxhaCqneNhWg"Nmv6zrJfYeiiovCuEs2grrBAZlREbRGl"a946d998-2ead-4894-bb50-1054a91dcab3"
```

--------------------------------

### Example Response

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

A sample XML response showing two groups returned for a user.

```xml
<tsResponse version-and-namespace-settings>
  <pagination pageNumber="1" pageSize="100" totalAvailable="2"/>
  <groups>
    <group id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" name="All Users" >
	  <domain name="mydomain"/>
	</group>
	<group id="4123e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6234" name="Researchers" >
	  <domain name="mydomain"/>
    </group>
  </groups>
</tsResponse>
```

--------------------------------

### Get View by Path cURL Request

Source: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm

Example request to retrieve a view using the viewUrlName filter.

```bash
curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views?filter=viewUrlName:eq:Sheet1" -X GET -H "X-Tableau-Auth:RDEj_zqgQtGGcCiD3BXnSA|abXWv8thv5ocrXLNU7axCicQu3UdfgeX"
```
Tokens:
Raw