Specifies the level of compatibility for the returned data, determining the format and functionality provided in query results.

Possible Values

Data Type

string

Default Value

"2"

Remarks

This property specifies the compatibility level of returned data, allowing you to choose between legacy formats or newer, feature-rich data formats such as multi-contact or multi-picklist data. Choose a compatibility level based on your application's needs:

• 0 (Backwards-compatible): Returns data in a legacy text format for maximum compatibility with older systems.
• 1 (Multi-contact data): Returns multi-contact data in a format optimized for standard processing but not specifically for report tables.
• 2 (Report-compatible multi-contact data): Returns multi-contact data in a format specifically designed for report tables.
• 3 (Multi-picklist data): Returns data in a format that supports multi-picklist fields for advanced use cases.

To retrieve data for report tables, the compatibility level must be set to at least 2. Adjust this property based on your application’s requirements to balance compatibility with advanced functionality.

This property is useful for managing how Smartsheet data is processed and consumed. Use it to align your data retrieval with application-specific needs, such as maintaining compatibility with older systems or leveraging advanced data structures for more complex use cases.