Rippling: List record detail related records
Rippling restApi.listCustomObjectRecordDetailRelatedRecords: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_custom_object_record_detail_related_records
Provider route: GET /record-detail-related-records/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["listCustomObjectRecordDetailRelatedRecords"]>[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.listCustomObjectRecordDetailRelatedRecords(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_record_detail_related_records(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.object_api_name | string | Required within parent | |
query.record_id | string | Required within parent | |
query.section_id | string | Required within parent | |
query.layout_api_name | string | Optional | Default: default |
query.expand | string | Optional | |
query.limit | integer | Optional | Default: 25 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “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 | |
next_link | JSON | Required within parent | |
next_link (anyOf 1) | string | Alternative | Link to the next page, or null. Format: uri |
next_link (anyOf 2) | null | Alternative | |
results | array | Required within parent | |
results[] | Model | Each item | Expand List record detail related records — response body — results item |
Referenced models: List record detail related records — response body — results item
Schemas
Section titled “Schemas”36 more schemas are linked from the tables above, on the schema pages.
List record detail related records — response body — results item
Referenced models: Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: DATE, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: DATETIME, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: SELECT, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: TEXT, LONG TEXT, EMAIL, URL, PHONE NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED
Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | BOOLEAN contains true or false. Known values: BOOLEAN |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | boolean | Alternative | Whether the configured condition is true; null unless value_state is PRESENT. |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | RADIO contains one configured choice. Known values: RADIO |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | One value from options; null unless value_state is PRESENT. |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value currency type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Platform Currency serialized with a decimal string amount to preserve precision. |
currency_type | string | Required within parent | ISO 4217 currency code, for example USD or EUR. Pattern: ^[A-Z]{3}$ |
value | string | Required within parent | Decimal monetary amount in currency units, for example 25.00; not integer cents. Pattern: ^[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?$ |
Retrieve a specific user — response body — photos item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | The classification of the photo. Known values: PHOTO, THUMBNAIL |
value | string | Optional | The URL of the photo. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_custom_object_record_detail_related_records. Catalog operation: list-custom-object-record-detail-related-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: ["Internal_Testing"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}