SmartSuite's REST API allows you to request "hydrated" records, returning human-readable labels alongside their underlying values. This reduces the number of API calls required to retrieve complete data, simplifying your workflows.

Hydrated records include both:

This feature is especially useful for fields like "Single Select" or "Assigned To," where labels improve clarity in application interfaces.

Use the hydrated=true parameter in the GET request:

Include the hydrated parameter in the JSON body of a POST request:

A hydrated record includes label-value pairs for supported fields. Example response:

Hydration is available for the following field types:

Scenario: Display user-friendly field labels in your application without additional API calls.

Solution: Use hydrated responses to retrieve both labels and values in one request.

Scenario: Your application needs both raw values and human-readable labels for a dataset.

Solution: Enable hydration to minimize redundant API calls for label lookups.

Scenario: Generate reports that include descriptive labels for fields like "Status" or "Tags."

Solution: Use hydrated responses to integrate label information directly into your reports.

By leveraging hydrated records, you can improve both the performance and usability of your applications. For further information, refer to the SmartSuite API Documentation.