Ramp: Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item
Fetch a spend program: response body, field custom_form_collection / custom_form_collection_log_entry / custom_form_collection_log_entry / 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 spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_dynamic_user_group_uuids | JSON | Optional | |
allowed_dynamic_user_group_uuids (anyOf 1) | array | Alternative | Dynamic user groups whose members may be selected for this field. Default: null |
allowed_dynamic_user_group_uuids (anyOf 1)[] | string | Each item | |
allowed_dynamic_user_group_uuids (anyOf 2) | null | Alternative | |
allowed_users | JSON | Optional | |
allowed_users (anyOf 1) | array | Alternative | Eligible users resolved for this form. Null applies no additional restriction; an empty list means no eligible users. Default: null |
allowed_users (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
answer_filter_workflow_definition | JSON | Optional | |
answer_filter_workflow_definition (anyOf 1) | Model | Alternative | Expand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices Workflow definition that conditionally filters this field’s choices. Default: null |
answer_filter_workflow_definition (anyOf 2) | null | Alternative | |
attachments | array | Optional | |
attachments[] | Model | Each item | Expand 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 |
conditions | JSON | Required within parent | |
conditions (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
default_answer_workflow_definition | JSON | Optional | |
default_answer_workflow_definition (anyOf 1) | Model | Alternative | Expand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices Workflow definition that conditionally defaults this field’s answer. Default: null |
default_answer_workflow_definition (anyOf 2) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
disclaimer | JSON | Required within parent | |
disclaimer (anyOf 1) | string | Alternative | |
disclaimer (anyOf 2) | null | Alternative | |
document_category | JSON | Optional | |
document_category (anyOf 1) | Model | Alternative | Expand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string Default: null |
document_category (anyOf 2) | null | Alternative | |
exclude_from_ai_prefill | boolean | Optional | When True, AI intake/document prefill never generates an answer for this field. Default: false |
field | Model | Required within parent | Expand Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field |
field_id | string | Required within parent | |
field_mapping_references | array | Optional | Integration field mappings that reference this question. |
field_mapping_references[] | Model | Each item | Expand 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_id | JSON | Optional | |
global_library_field_id (anyOf 1) | string | Alternative | Default: null |
global_library_field_id (anyOf 2) | null | Alternative | |
is_mapped_to_ironclad_field | boolean | Optional | Default: false |
is_used_in_approval_workflow_approval_step | boolean | Optional | Whether an approval step selects its approver from this field. Default: false |
is_used_in_approval_workflow_condition | boolean | Optional | Broad compatibility flag for fields used in approval conditions or approval steps. Default: false |
is_used_in_custom_form_workflow_condition | boolean | Optional | Default: false |
label | string | Required within parent | |
required | boolean | Required within parent | |
required_if_conditions | JSON | Optional | |
required_if_conditions (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
short_title | JSON | Optional | |
short_title (anyOf 1) | string | Alternative | Optional concise title copied from a Global Question Library field. Default: null |
short_title (anyOf 2) | null | Alternative |
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 conditions condition, then, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item answer filter workflow definition fallback vertices, vertices, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item field, Fetch a spend program — response body — custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string, 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