Skip to content

Rippling: Retrieve a custom object list view — response body

Retrieve a custom object list view: response body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Retrieve a custom object list view — response body

FieldTypePresenceDescription and constraints
$objectRootA saved Custom Object grid configuration for selecting, filtering, and ordering records.
columnsarrayRequired within parentVisible columns, in saved display order.
columns[]ModelEach itemExpand Retrieve a custom object list view — response body — columns item
created_atstringRequired within parentRecord creation date
descriptionJSONOptional
description (anyOf 1)stringAlternativeCreator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved.
description (anyOf 2)nullAlternative
has_filterbooleanRequired within parentWhether this view applies a saved filter in addition to record_scope. The server resolves it when view_id is supplied to record queries; its expression and values are not disclosed.
idstringRequired within parentIdentifier field
is_defaultbooleanRequired within parentWhether this is the company’s default view for this object.
namestringRequired within parentDisplay name of the saved view.
order_byJSONOptional
order_by (anyOf 1)stringAlternativeSaved field and asc/desc direction; null means no saved ordering.
order_by (anyOf 2)nullAlternative
record_scopestringRequired within parentMY_RECORDS restricts owners to the authenticated requester when the view is used.
Known values: ALL, MY_RECORDS
updated_atstringRequired within parentRecord update date
visibilitystringRequired within parentPRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access.
Known values: PRIVATE, SHARED

Referenced models: Retrieve a custom object list view — response body — columns item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.