Rippling: List custom object fields — response body — results item

API reference · Contract 2026-10-28

SDK schema: List custom object fields — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
api_name	string	Required within parent	The api name of the custom object field
created_at	string	Required within parent	Record creation date
custom_object	string	Required within parent	The custom object which the field belongs to
data_type	object	Required within parent	The data type configuration for the field. Additional keys: allowed
data_type.num_of_decimal_places	JSON	Optional
data_type.num_of_decimal_places (anyOf 1)	integer	Alternative	Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated. Maximum: 15 Minimum: 0
data_type.num_of_decimal_places (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	The description of the custom object field
enable_history	boolean	Required within parent	whether the history is enable for the field
id	string	Required within parent	Identifier field
is_immutable	boolean	Required within parent	whether the field is imuatable
is_standard	boolean	Required within parent	whether the field is standard field
is_unique	boolean	Required within parent	This field specifies whether a particular column value has unique values
managed_package_install_id	string	Optional	The id of the package which the custom object field belongs to
name	string	Required within parent	The name of the custom object field
updated_at	string	Required within parent	Record update date