Skip to content

Rippling: List custom fields — response body — results item

List custom fields: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: List custom fields — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
descriptionstringOptionalThe description of the custom field.
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the custom field.
optionsarrayOptionalThe available choice values for SELECT and RADIO custom fields. Null for other field types.
options[]stringEach item
requiredbooleanOptionalWhether the custom field is required.
typestringRequired within parentThe data type of the custom field.
Known values: TEXT, DATE, NUMBER, CURRENCY, PERCENTAGE, SELECT, FILE, ID, RADIO, TEXTAREA, RANGE, REFERENCE_ID, BOOLEAN, ADDRESS, OG_REFERENCE_FIELD, NATIVE_EDGE, DATETIME, EMAIL, URL
updated_atstringRequired within parentRecord update date

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.