Skip to content

Ramp: Get a unified request — response body — value agreement contract type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item

Get a unified request: response body, field value / agreement_contract_type: ONE_TIME, PERPETUAL, RENEWABLE, request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend_request_type: APPROVAL_ONLY, unified_request_type: SPEND_REQUEST, unified_spend_request_type: APPROVAL_ONLY / agreement_contract_type: ONE_TIME, PERPETUAL, RENEWABLE / agreement_contract_type: ONE_TIME, PERPETUAL, RENEWABLE / sanitized_approval_steps / array / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item

FieldTypePresenceDescription and constraints
$objectRoot
_ramp_event_typestringRequired within parent
assigned_entitiesarrayRequired within parent
assigned_entities[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item
completed_approval_countJSONRequired within parent
completed_approval_count (anyOf 1)JSONAlternative
completed_approval_count (anyOf 1) (anyOf 1)integerAlternativeSatisfied eligible selected principals, including delegate credit; capped at the effective target.
Default: null
completed_approval_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
completed_approval_count (anyOf 2)nullAlternative
displayed_event_textstringRequired within parent
eligible_approver_countJSONRequired within parent
eligible_approver_count (anyOf 1)JSONAlternative
eligible_approver_count (anyOf 1) (anyOf 1)integerAlternativeDistinct eligible selected people across direct selections and groups, excluding delegate-only users.
Default: null
eligible_approver_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
eligible_approver_count (anyOf 2)nullAlternative
event_orderJSONRequired within parent
event_order (anyOf 1)integerAlternative
event_order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
event_typestringRequired within parentKnown values: NOTIFY, REQUIRE, REQUIRE_ALL, ROUND_ROBIN
idstringRequired within parent
is_current_stepbooleanRequired within parent
is_delegatebooleanRequired within parentDefault: false
is_last_step_for_userbooleanRequired within parent
needs_user_actionbooleanRequired within parent
needs_user_trigger_actionbooleanRequired within parentDefault: false
notesJSONRequired within parent
notes (anyOf 1)stringAlternativeDefault: null
notes (anyOf 2)nullAlternative
raw_step_orderJSONRequired within parent
raw_step_order (anyOf 1)integerAlternative
raw_step_order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
required_approval_countJSONRequired within parent
required_approval_count (anyOf 1)JSONAlternative
required_approval_count (anyOf 1) (anyOf 1)integerAlternativeConfigured approval target; execution caps it at eligible_approver_count.
Default: null
required_approval_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
required_approval_count (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: ADMIN_APPROVED, ADMIN_REJECTED, APPROVED, COMPLETED, MANUALLY_SKIPPED, PENDING, REJECTED, SKIPPED, TERMINATED
step_creator_user_idJSONRequired within parent
step_creator_user_id (anyOf 1)stringAlternativeDefault: null
step_creator_user_id (anyOf 2)nullAlternative
step_dateJSONRequired within parent
step_date (anyOf 1)stringAlternativeDefault: null
step_date (anyOf 2)nullAlternative
substepsarrayRequired within parent
substeps[]ModelEach itemExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item substeps item
trigger_entity_metadataJSONOptional
trigger_entity_metadata (anyOf 1)ModelAlternativeExpand Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value
trigger_entity_metadata (anyOf 2)nullAlternative

Referenced models: Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item substeps item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item assigned entities item, Get a unified request — response body — value / agreement_contract_type: ONE TIME, PERPETUAL, RENEWABLE, request status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY agreement contract type: ONE TIME, PERPETUAL, RENEWABLE agreement contract type: ONE TIME, PERPETUAL, RENEWABLE sanitized approval steps array item trigger entity metadata value

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.