Rippling: List custom object records by query

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.list_by_query_custom_objects_custom_object_api_name_records

Provider route: POST /custom-objects/{custom_object_api_name}/records/query/. Alter supplies the connection’s credentials and routing.

Call through Alter

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"]["listByQueryCustomObjectsCustomObjectApiNameRecords"]>[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.listByQueryCustomObjectsCustomObjectApiNameRecords(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_by_query_custom_objects_custom_object_api_name_records(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.custom_object_api_name	string	Required within parent
body	object	Optional
body.cursor	string	Optional	A cursor for pagination to fetch the next page of results.
body.limit	integer	Optional	The maximum number of results to return.
body.order_by	string	Optional	Order results by one readable field API name followed by optional asc (ascending) or desc (descending). Direction defaults to asc; multiple fields and nested paths are not supported. For example: name desc. Overrides search relevance order. Reference fields use the same ordering as the Custom Object grid. A record ID tie-breaker makes the order deterministic; traversal is not a snapshot of concurrently changing records. Omit order_by to retain the existing default order. Reset cursor when criteria change. Pattern: ^\s*[A-Za-z_][A-Za-z0-9_](?: +(asc|desc))?\s$
body.query	string	Optional	An optional RQL expression that filters custom object records. For example: owner_role = “role-id” AND status__c IN [“FINAL”, “APPROVED”].
body.search	string	Optional	Search record names or owners. Name search uses token/prefix matching, not arbitrary substring matching. Native exact record ID and external ID matching is also retained. ANDed with query before pagination. Whitespace is trimmed; omitting search or sending a blank string disables it. Some older Custom Objects do not support search and return HTTP 400; omit search to use filters. Owner matching uses a bounded worker search, so broad terms may not include every matching owner. Use an owner_role query filter for an exact owner. Without order_by, native search order applies. Repeat search, query, and order_by unchanged when following a cursor.

Response

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

Field	Type	Presence	Description and constraints
$	object	Root
cursor	string	Optional
results	array	Optional
results[]	Model	Each item	Expand Retrieve a specific custom object record — response body

Referenced models: Retrieve a specific custom object record — response body

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.list_by_query_custom_objects_custom_object_api_name_records. Catalog operation: list-by-query-custom-objects/(custom-object-api-name)/records. 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-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner"]

Provider entitlements: ["API_Tier_1"]

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

Official provider source