Skip to content

Rippling: Retrieve a specific Custom App

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

← Rest API operations · Get started

Operation rippling.rest_api.get_custom_apps

Provider route: GET /custom-apps/{id}/. 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"]["getCustomApps"]>[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.getCustomApps(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.get_custom_apps(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentFormat: id

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaobjectOptional
__meta.redacted_fieldsarrayOptional
__meta.redacted_fields[]ModelEach itemExpand Retrieve a report run — response body — meta redacted fields item
api_namestringRequired within parentThe unique api name of the custom app
created_atstringOptionalRecord creation date
descriptionstringOptionalThe description of the custom app
iconstringOptionalThe icon URL of the custom app
idstringOptionalIdentifier field
namestringRequired within parentThe display name of the custom app
pagesarrayOptionalThe pages of the custom app
pages[]ModelEach itemExpand Update a Custom App — response body — pages item
updated_atstringOptionalRecord update date

Referenced models: Update a Custom App — response body — pages item, Retrieve a report run — response body — meta redacted fields item

Update a Custom App — response body — pages item
FieldTypePresenceDescription and constraints
$objectRootSummary of a page attached to a custom app.
api_namestringOptionalThe unique name of the page within the app
canvas_instance_idstringOptionalThe ID of the canvas instance backing this page (canvas_page only)
created_bystringOptionalThe ID of the role that created the page
function_idstringOptionalThe ID of the Rippling Function rendering this page (sdui_page only)
page_typestringOptionalThe type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
sdui_page_idstringOptionalThe ID of the SDUI page instance (sdui_page only)
updated_bystringOptionalThe ID of the role that last modified the page
Retrieve a report run — response body — meta redacted fields item
FieldTypePresenceDescription and constraints
$objectRootInfo about the redacted fields.
namestringOptionalThe name for the redacted field
reasonstringOptionalThe reason for the redaction

SDK function policy ID: rippling.rest_api.get_custom_apps. Catalog operation: get-custom-apps. 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-apps.read"]

Provider entitlements: ["Custom_Apps_Platform_API"]

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.