Skip to content

Rippling: Retrieve list view capabilities for a custom object

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

← Rest API operations · Get started

Operation rippling.rest_api.capabilities_custom_object_list_view

Provider route: GET /custom-objects/{custom_object_api_name}/list-views/capabilities/. 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"]["capabilitiesCustomObjectListView"]>[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.capabilitiesCustomObjectListView(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.capabilities_custom_object_list_view(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve list view capabilities for a custom object — response body

Referenced models: Retrieve list view capabilities for a custom object — response body

Retrieve list view capabilities for a custom object — response body
FieldTypePresenceDescription and constraints
$objectRootPermissions to create saved views and choose a company default for a Custom Object.
can_create_privatebooleanRequired within parentWhether the caller may create private views.
can_create_sharedbooleanRequired within parentWhether the caller may create shared views.
can_set_defaultbooleanRequired within parentWhether the caller may change the company default.

SDK function policy ID: rippling.rest_api.capabilities_custom_object_list_view. Catalog operation: capabilities-custom-object-list-view. 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.