Skip to content

Rippling: Retrieve a specific custom object record — response body

Retrieve a specific custom object record: response body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Retrieve a specific custom object record — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: see wildcard field
created_atstringRequired within parentRecord creation date
created_byobjectOptional
created_by.display_valuestringOptionalThe display name of the role.
created_by.idstringOptionalThe unique identifier of the role.
created_by.imagestringOptionalThe URL of the role’s profile image.
external_idstringOptionalThe external id of the custom object datarow
idstringRequired within parentIdentifier field
last_modified_byobjectOptional
last_modified_by.display_valuestringOptionalThe display name of the role.
last_modified_by.idstringOptionalThe unique identifier of the role.
last_modified_by.imagestringOptionalThe URL of the role’s profile image.
namestringRequired within parentThe name of the custom object datarow
owner_roleobjectOptional
owner_role.display_valuestringOptionalThe display name of the role.
owner_role.idstringOptionalThe unique identifier of the role.
owner_role.imagestringOptionalThe URL of the role’s profile image.
system_updated_atstringOptionalThe timestamp when the record was last updated by the system.
updated_atstringRequired within parentRecord update date
$.*JSONAdditional keys

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.