Skip to content

Ramp: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item

Fetch a custom form collection response by ID: response body, field custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item

FieldTypePresenceDescription and constraints
$objectRoot
allowed_dynamic_user_group_uuidsJSONOptional
allowed_dynamic_user_group_uuids (anyOf 1)arrayAlternativeDynamic user groups whose members may be selected for this field.
Default: null
allowed_dynamic_user_group_uuids (anyOf 1)[]stringEach item
allowed_dynamic_user_group_uuids (anyOf 2)nullAlternative
allowed_usersJSONOptional
allowed_users (anyOf 1)arrayAlternativeEligible users resolved for this form. Null applies no additional restriction; an empty list means no eligible users.
Default: null
allowed_users (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item
allowed_users (anyOf 2)nullAlternative
attachmentsarrayOptional
attachments[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item
conditionsJSONRequired within parent
conditions (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
conditions (anyOf 2)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
exclude_from_ai_prefillbooleanOptionalWhen True, AI intake/document prefill never generates an answer for this field.
Default: false
fieldModelRequired within parentExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field
field_idstringRequired within parent
field_mapping_referencesarrayOptionalIntegration field mappings that reference this question.
field_mapping_references[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item
global_library_field_idJSONOptional
global_library_field_id (anyOf 1)stringAlternativeDefault: null
global_library_field_id (anyOf 2)nullAlternative
is_mapped_to_ironclad_fieldbooleanOptionalDefault: false
is_used_in_approval_workflow_approval_stepbooleanOptionalWhether an approval step selects its approver from this field.
Default: false
is_used_in_approval_workflow_conditionbooleanOptionalBroad compatibility flag for fields used in approval conditions or approval steps.
Default: false
is_used_in_custom_form_workflow_conditionbooleanOptionalDefault: false
labelstringRequired within parent
requiredbooleanRequired within parent
required_if_conditionsJSONOptional
required_if_conditions (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
Conditions that make this field required when they evaluate to true.
Default: null
required_if_conditions (anyOf 2)nullAlternative
short_titleJSONOptional
short_title (anyOf 1)stringAlternativeOptional concise title copied from a Global Question Library field.
Default: null
short_title (anyOf 2)nullAlternative
validation_errorsarrayOptional
validation_errors[]ModelEach itemExpand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item validation errors item
value_display_stringJSONRequired within parent
value_display_string (anyOf 1)stringAlternativeRead only: true
value_display_string (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item validation errors item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item

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.