Ramp: List vendor agreements — response body — data item

API reference · Contract 2026-10-27

SDK schema: List vendor agreements — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
auto_renewal	boolean	Required within parent
available_actions	object	Required within parent
contract_owners	array	Required within parent
contract_owners[]	Model	Each item	Expand Fetch a vendor agreement — response body — contract owners item
created_at	string	Required within parent	Format: date-time
currency	string	Required within parent
custom_record_field_values	array	Required within parent
custom_record_field_values[]	Model	Each item	Expand Get a business entity — response body — custom record fields item
days_remaining	Model	Required within parent	Expand Fetch a vendor agreement — response body — days remaining
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
department	JSON	Optional
department (anyOf 1)	Model	Alternative	Expand List vendor agreements — response body — data item department id, name
department (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
draft_spend_requests	array	Required within parent
draft_spend_requests[]	Model	Each item	Expand Fetch a vendor agreement — response body — draft spend requests item
end_date	JSON	Optional
end_date (anyOf 1)	string	Alternative	Format: date
end_date (anyOf 2)	null	Alternative
has_approved_renewal_request	boolean	Required within parent
id	string	Required within parent	Format: uuid
is_snoozed	boolean	Required within parent
is_up_for_renewal	boolean	Required within parent
last_date_to_terminate	JSON	Optional
last_date_to_terminate (anyOf 1)	string	Alternative	Format: date
last_date_to_terminate (anyOf 2)	null	Alternative
latest_renewal_request	JSON	Optional
latest_renewal_request (anyOf 1)	Model	Alternative	Expand List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED
latest_renewal_request (anyOf 2)	null	Alternative
logo	JSON	Optional
logo (anyOf 1)	string	Alternative
logo (anyOf 2)	null	Alternative
name	string	Required within parent
notifications_on	boolean	Required within parent
payee_id	string	Required within parent	Format: uuid
payee_name	string	Required within parent
renewal_status	string	Required within parent	Known values: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED
start_date	JSON	Optional
start_date (anyOf 1)	string	Alternative	Format: date
start_date (anyOf 2)	null	Alternative
total_value	Model	Required within parent	Expand Hold Bill — response body — amount
updated_at	string	Required within parent	Format: date-time
uploaded_by_user	JSON	Optional
uploaded_by_user (anyOf 1)	Model	Alternative	Expand List vendor agreements — response body — data item uploaded by user email, first name, full name, id, last name, profile picture url Recorded uploader of the source document’s latest version, or null when unavailable.
uploaded_by_user (anyOf 2)	null	Alternative
vendor_owners	array	Required within parent
vendor_owners[]	Model	Each item	Expand List vendor agreements — response body — data item vendor owners item

Referenced models: Fetch a vendor agreement — response body — contract owners item, List vendor agreements — response body — data item department id, name, List vendor agreements — response body — data item uploaded by user email, first name, full name, id, last name, profile picture url, List vendor agreements — response body — data item vendor owners item, Fetch a vendor agreement — response body — days remaining, Fetch a vendor agreement — response body — draft spend requests item, List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item