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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A saved Custom Object grid configuration for selecting, filtering, and ordering records. |
columns | array | Required within parent | Visible columns, in saved display order. |
columns[] | Model | Each item | Expand Retrieve a custom object list view — response body — columns item |
created_at | string | Required within parent | Record creation date |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved. |
description (anyOf 2) | null | Alternative | |
has_filter | boolean | Required within parent | Whether 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. |
id | string | Required within parent | Identifier field |
is_default | boolean | Required within parent | Whether this is the company’s default view for this object. |
name | string | Required within parent | Display name of the saved view. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | Saved field and asc/desc direction; null means no saved ordering. |
order_by (anyOf 2) | null | Alternative | |
record_scope | string | Required within parent | MY_RECORDS restricts owners to the authenticated requester when the view is used. Known values: ALL, MY_RECORDS |
updated_at | string | Required within parent | Record update date |
visibility | string | Required within parent | PRIVATE 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