Tableau CRM REST API Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Abstract Field
Advanced Property Value
Advanced Property
Annotation Collection
Annotation
App Log
Asset Reference
Auto-Install App Configuration
Auto-Install Configuration
Auto-Install Request Collection
Auto-Install Request
Base Asset Reference
Base Wave Asset
Bounding Box
Conditional Formatting Property
Connection Property Value
Connection Property
Data Connector Collection
Data Connector Status
Data Connector Type Collection
Data Connector Type
Data Connector
Dataflow Collection
Dataflow Job Collection
Dataflow Job
Dataflow Job Node Collection
Dataflow Job Node
Dataflow
Dataset Collection
Dataset Coverage
Dataset Source
Dataset Version Collection
Dataset Version Reference
Dataset Version
Dataset
Dependency
Dependency Collection
Directory Item Collection
Display Message
Featured Assets
Geo Data Collection
Geo Data
Image Asset Reference
Json Transformation
License Attributes
Literal Json
Live Connection
Macro Definition
Map Collection
Map
Node Row Count
Numeric Separators
Object Coverage
Output Source
Page
Page Variable
Permissions
Recipe Collection
Recipe Configuration Collection
Recipe Configuration Fiscal
Recipe Configuration Fiscal Offset
Recipe Configuration
Recipe Conversion Detail
Recipe Definition
Recipe Notification
Recipe Validation Detail
Recipe
Replicated Dataset Collection
Replicated Dataset
Replicated Field Collection
Replicated Field
Restore Dataset Version
Schedule
Source Field Collection
Source Field
Source Object Collection
Source Object Data
Source Object
Template
Template Configuration
Template Custom Attributes
Template Icons
Template Options
Template Release
Template Release Notes
Time
Time Zone
Typed Asset Reference
UI Configuration
UI Definition
Unsupported Record Collection
Unsupported Record
User Collection
Variable Definition
Video Info
Wave Analytics Limit
Wave Analytics Limit Collection
Wave Collection
Wave Collection Item
Wave Collection Item List
Wave Collection List
Wave Features
Wave File Metadata
Wave Folder
Wave Folder Collection
Wave Folder Share
Wave User
Xmd Date Field
Xmd Date
Xmd Dimension Custom Action
Xmd Dimension Member
Xmd Dimension Salesforce Action
Xmd Dimension
Xmd Measure Format
Xmd Measure
Xmd Organization
Xmd
Newer Version Available
Tableau CRM REST API Response Bodies
The successful execution of a request to a Tableau CRM REST API resource can return a
response body in either JSON or XML format.
A request to a Tableau CRM REST API resource always returns an HTTP response code, whether the request was successful or not.
-
Abstract Field
The base definition of a dataset field. -
Advanced Property Value
An advanced property name and value pair. -
Advanced Property
An advanced property is a replication property for a data connector source object. -
Annotation Collection
A collection of annotations. -
Annotation
A Tableau CRM annotation. -
App Log
The app log for app creation and updates. -
Asset Reference
A Tableau CRM asset reference. This wraps the BaseAssetReference. -
Auto-Install App Configuration
The configuration for a auto-install app. -
Auto-Install Configuration
The configuration for a auto-install request. -
Auto-Install Request Collection
A collection of auto-install requests. -
Auto-Install Request
A auto-install request. -
Base Asset Reference
The base Tableau CRM asset, inherited by Asset Reference, Image Asset Reference, Slack Reference, Typed Asset Reference. -
Base Wave Asset
The base Tableau CRM asset, inherited by AnalyticsAsset, BaseTemplatedAsset, DataConnector, DataflowJobNode, DataflowJob, Dataflow, Dataset, DatasetVersion, Recipe, ReplicatedDataset, WaveCollectionItem, WaveCollection, and WaveFolder. -
Bounding Box
A bounding box of a map. -
Conditional Formatting Property
The extended metadata (Xmd) for a property in the conditional formatting for a Tableau CRM dataset dimension or measure. -
Connection Property Value
A connection property name and value pair. -
Connection Property
A property used to connect to a Tableau CRM data connector. -
Data Connector Collection
A collection of Tableau CRM data connectors. -
Data Connector Status
The status for a Tableau CRM data connector. -
Data Connector Type Collection
A collection of Tableau CRM data connector types. -
Data Connector Type
A Tableau CRM data connector type. -
Data Connector
A Tableau CRM data connector. -
Dataflow Collection
A collection of Tableau CRM dataflows. -
Dataflow Job Collection
A collection of Tableau CRM dataflow jobs. -
Dataflow Job
A Tableau CRM dataflow job. -
Dataflow Job Node Collection
The collection of nodes for a Tableau CRM dataflow job. -
Dataflow Job Node
A node in a dataflow job. -
Dataflow
A Tableau CRM dataflow. -
Dataset Collection
A collection of datasets. -
Dataset Coverage
The security coverage for a specific dataset version. -
Dataset Source
The source object used to create a dataset. -
Dataset Version Collection
A collection of versions for a Tableau CRM dataset. -
Dataset Version Reference
The dataset version the coverage information applies to. -
Dataset Version
A specific version of a Tableau CRM dataset. -
Dataset
A Tableau CRM dataset. -
Dependency
A Tableau CRM asset dependency. -
Dependency Collection
A collection of Tableau CRM asset dependencies. -
Directory Item Collection
A collection of directory items. -
Display Message
The display message for a Tableau CRM template. -
Featured Assets
The featured assets. -
Geo Data Collection
A collection of the geo data used by a map. -
Geo Data
The geo data used by a map. -
Image Asset Reference
A image asset for Tableau CRM. -
Json Transformation
The transformed JSON after processing the transformation rules. -
License Attributes
The Analytics license attributes. -
Literal Json
A string of JSON content results, usually for a query response. -
Live Connection
The connection details of a Tableau CRM live dataset. -
Macro Definition
A macro definition that is part of a larger macro for a JSON transformation rule. -
Map Collection
A collection of maps. -
Map
A map object. -
Node Row Count
The node row count for a Tableau CRM dataflow job node. -
Numeric Separators
The numeric separators for thousands and decimals, used in formatting. -
Object Coverage
The security coverage for a source object. -
Output Source
The output source for a Tableau CRM replicated dataset, also known as a connected object. -
Page
A UI page for a Tableau CRM template. -
Page Variable
A Tableau CRM variable to display on a UI page. -
Permissions
The user permissions for a Tableau CRM asset. -
Recipe Collection
A collection of Tableau CRM data prep recipes. -
Recipe Configuration Collection
A collection of Tableau CRM data prep recipe configurations. -
Recipe Configuration Fiscal
The Tableau CRM data prep recipe fiscal configuration data. -
Recipe Configuration Fiscal Offset
The Tableau CRM data prep recipe fiscal offset configuration data. -
Recipe Configuration
The Tableau CRM data prep recipe configuration data. -
Recipe Conversion Detail
The details for the upconversion of a Tableau CRM data prep recipe. -
Recipe Definition
The definition for a Tableau CRM data prep recipe. Available on for R3 recipes. -
Recipe Notification
A notification for a Tableau CRM data prep recipe. -
Recipe Validation Detail
The validation details for a Tableau CRM recipe. -
Recipe
A Tableau CRM data prep recipe. -
Replicated Dataset Collection
A collection of Tableau CRM replicated datasets, also know as connected objects. -
Replicated Dataset
A Tableau CRM replicated dataset, also know as a connected object. -
Replicated Field Collection
A collection of fields for a Tableau CRM replicated dataset, also known as a connected object. -
Replicated Field
A field for a Tableau CRM replicated dataset, also known as a connected object. -
Restore Dataset Version
The message returned for a Tableau CRM data connector ingest request or a Tableau CRM dataset version update request. -
Schedule
A schedule on which to execute some type of Tableau CRM job. -
Source Field Collection
A collection of fields for a source object. -
Source Field
A field for a source object. -
Source Object Collection
A collection of source objects for a Tableau CRM data connector. -
Source Object Data
The data retrieved from a source object given a list of fields and advanced properties. -
Source Object
A source object for a Tableau CRM data connector. -
Template
A Tableau CRM template. -
Template Configuration
The configuration for a Tableau CRM Template. -
Template Custom Attributes
The custom attributes or metadata for a Tableau CRM template. -
Template Icons
The icons for a Tableau CRM template. -
Template Options
The template options used on the last action performed on a templated Tableau CRM app. -
Template Release
The release information for a Tableau CRM template. -
Template Release Notes
The release notes for a Tableau CRM template. -
Time
The time at which something should happen, usually in relation to a Tableau CRM schedule. -
Time Zone
The time zone in which something should happen, usually in relation to a Tableau CRM schedule. -
Typed Asset Reference
A typed Tableau CRM asset reference. -
UI Configuration
Get the Tableau CRM UI configuration data. -
UI Definition
The UI definition for a Tableau CRM template. -
Unsupported Record Collection
The collection of specific records that unsupported for sharing inheritance. -
Unsupported Record
The sharing usage of object instances based on Tableau CRM limits. -
User Collection
Information for a user. Used by the Map representation -
Variable Definition
The variable definition for a Tableau CRM template. Specific variable type responses are listed here. -
Video Info
Information for describing a particular video. -
Wave Analytics Limit
A Tableau CRM limit. -
Wave Analytics Limit Collection
The collection of Tableau CRM limits. -
Wave Collection
A collection of Tableau CRM resources. -
Wave Collection Item
An item in a collection of Tableau CRM resources. -
Wave Collection Item List
A list of items in a collection of Tableau CRM resources. -
Wave Collection List
A list of Tableau CRM collections. -
Wave Features
The Tableau CRM features enabled for a user. -
Wave File Metadata
The metadata for a Tableau CRM file. -
Wave Folder
A Tableau CRM folder. -
Wave Folder Collection
A collection of Tableau CRM folders. -
Wave Folder Share
A Tableau CRM folder sharing rule. -
Wave User
A Tableau CRM user. -
Xmd Date Field
The extended metadata (Xmd) for the formatting of date fields. -
Xmd Date
The extended metadata (Xmd) for a date. -
Xmd Dimension Custom Action
The extended metadata (Xmd) for a custom action on a Tableau CRM dataset dimension. -
Xmd Dimension Member
The extended metadata (Xmd) for a member linked to a dimension in Tableau CRM dataset. -
Xmd Dimension Salesforce Action
The extended metadata (Xmd) for a Saleforce Action for a dimension in a Tableau CRM dataset. -
Xmd Dimension
The extended metadata (Xmd) for a dimension in a Tableau CRM dataset. -
Xmd Measure Format
The extended metadata (Xmd) for the format of a measure in a Tableau CRM dataset. -
Xmd Measure
The extended metadata (Xmd) for a measure in a Tableau CRM dataset. -
Xmd Organization
The extended metadata (Xmd) for an organization in a Tableau CRM dataset. -
Xmd
The extended metadata (Xmd) for a Tableau CRM dataset version.