Skip to content

Rippling: List custom object list views

Rippling restApi.listCustomObjectListViews: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_custom_object_list_views

Provider route: GET /custom-objects/{custom_object_api_name}/list-views/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listCustomObjectListViews"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.listCustomObjectListViews(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.list_custom_object_list_views(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.custom_object_api_namestringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
next_linkJSONRequired within parent
next_link (anyOf 1)stringAlternativeFormat: uri
next_link (anyOf 2)nullAlternative
resultsarrayRequired within parent
results[]ModelEach itemExpand List custom object list views — response body — results item

Referenced models: List custom object list views — response body — results item

List custom object list views — response body — results item
FieldTypePresenceDescription and constraints
$objectRootA saved Custom Object grid configuration for selecting, filtering, and ordering records.
api_namestringRequired within parentStable API name used to address this view.
capabilitiesModelRequired within parentExpand Create a custom object list view — response body — capabilities
columnsarrayRequired within parentVisible columns, in saved display order.
columns[]ModelEach itemExpand Create a custom object list view — response body — columns item
created_atstringRequired within parentTime the view was created, as an ISO 8601 timestamp in UTC.
Format: date-time
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_api_name is supplied to record queries.
idstringRequired within parentRead-only internal identifier; address operations using api_name.
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 ordering as one field API name, a space, and lowercase asc or desc, for example name asc. 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 parentTime the view was last updated, as an ISO 8601 timestamp in UTC.
Format: date-time
visibilitystringRequired within parentPRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access.
Known values: PRIVATE, SHARED

Referenced models: Create a custom object list view — response body — columns item, Create a custom object list view — response body — capabilities

Create a custom object list view — response body — columns item
FieldTypePresenceDescription and constraints
$objectRootA visible field within a Custom Object list view.
fieldstringRequired within parentField API name.
Create a custom object list view — response body — capabilities
FieldTypePresenceDescription and constraints
$objectRootActions available to this caller.
can_deletebooleanRequired within parentWhether the caller may delete this view.
can_duplicatebooleanRequired within parentWhether the caller may create a copy of this definition.
can_set_defaultbooleanRequired within parentWhether the caller may make this view the company default.
can_sharebooleanRequired within parentWhether the caller may make this private view shared.
can_updatebooleanRequired within parentWhether the caller may edit this view.

SDK function policy ID: rippling.rest_api.list_custom_object_list_views. Catalog operation: list-custom-object-list-views. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner"]

Provider entitlements: ["Internal_Testing"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

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.