Ramp: List vendor agreements — request body — body
List vendor agreements: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List vendor agreements — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreement_custom_records | JSON | Optional | |
agreement_custom_records (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and JSON object describing custom record filters for agreements. Schema name: CustomRecordsQueryAndClauseAdapter |
agreement_custom_records (anyOf 2) | null | Alternative | |
auto_renews | JSON | Optional | |
auto_renews (anyOf 1) | boolean | Alternative | Filter by whether the agreement auto-renews. Default: null |
auto_renews (anyOf 2) | null | Alternative | |
contract_owner_ids | JSON | Optional | |
contract_owner_ids (anyOf 1) | array | Alternative | Filter by contract owner IDs. |
contract_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
contract_owner_ids (anyOf 2) | null | Alternative | |
department_ids | JSON | Optional | |
department_ids (anyOf 1) | array | Alternative | Filter by department IDs. |
department_ids (anyOf 1)[] | string | Each item | Format: uuid |
department_ids (anyOf 2) | null | Alternative | |
end_date_range | JSON | Optional | |
end_date_range (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body end date range end, start JSON object describing a relative end date range filter. |
end_date_range (anyOf 2) | null | Alternative | |
exclude_snoozed | JSON | Optional | |
exclude_snoozed (anyOf 1) | boolean | Alternative | Exclude snoozed agreements when true. Default: null |
exclude_snoozed (anyOf 2) | null | Alternative | |
has_end_date | JSON | Optional | |
has_end_date (anyOf 1) | boolean | Alternative | Filter by whether the agreement has an end date. Default: null |
has_end_date (anyOf 2) | null | Alternative | |
has_pending_expansion_requests | JSON | Optional | |
has_pending_expansion_requests (anyOf 1) | boolean | Alternative | Filter by whether the agreement has pending expansion requests. Default: null |
has_pending_expansion_requests (anyOf 2) | null | Alternative | |
has_reminders | JSON | Optional | |
has_reminders (anyOf 1) | boolean | Alternative | Filter by whether the agreement has reminders configured. Default: null |
has_reminders (anyOf 2) | null | Alternative | |
include_archived | boolean | Optional | Include archived agreements when true. Default: false |
is_active | JSON | Optional | |
is_active (anyOf 1) | boolean | Alternative | Filter by whether the agreement is active. Default: null |
is_active (anyOf 2) | null | Alternative | |
is_up_for_renewal | JSON | Optional | |
is_up_for_renewal (anyOf 1) | boolean | Alternative | Filter by whether the agreement is up for renewal. Default: null |
is_up_for_renewal (anyOf 2) | null | Alternative | |
last_date_to_terminate_range | JSON | Optional | |
last_date_to_terminate_range (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body end date range end, start JSON object describing a relative last date to terminate range filter. |
last_date_to_terminate_range (anyOf 2) | null | Alternative | |
max_days_remaining | JSON | Optional | |
max_days_remaining (anyOf 1) | integer | Alternative | Filter by agreements with days remaining less than or equal to this value. Default: null |
max_days_remaining (anyOf 2) | null | Alternative | |
max_end_date | JSON | Optional | |
max_end_date (anyOf 1) | string | Alternative | Filter by agreements whose end date is on or before the provided date. Default: null Format: date |
max_end_date (anyOf 2) | null | Alternative | |
max_last_date_to_terminate | JSON | Optional | |
max_last_date_to_terminate (anyOf 1) | string | Alternative | Filter by agreements whose last date to terminate is on or before the provided date. Default: null Format: date |
max_last_date_to_terminate (anyOf 2) | null | Alternative | |
max_start_date | JSON | Optional | |
max_start_date (anyOf 1) | string | Alternative | Filter by agreements whose start date is on or before the provided date. Default: null Format: date |
max_start_date (anyOf 2) | null | Alternative | |
max_total_value | JSON | Optional | |
max_total_value (anyOf 1) | JSON | Alternative | Filter by agreements with total value less than or equal to this value. Default: null |
max_total_value (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
max_total_value (anyOf 1) (oneOf 2) | number | Alternative | |
max_total_value (anyOf 2) | null | Alternative | |
min_days_remaining | JSON | Optional | |
min_days_remaining (anyOf 1) | integer | Alternative | Filter by agreements with days remaining greater than or equal to this value. Default: null |
min_days_remaining (anyOf 2) | null | Alternative | |
min_end_date | JSON | Optional | |
min_end_date (anyOf 1) | string | Alternative | Filter by agreements whose end date is on or after the provided date. Default: null Format: date |
min_end_date (anyOf 2) | null | Alternative | |
min_last_date_to_terminate | JSON | Optional | |
min_last_date_to_terminate (anyOf 1) | string | Alternative | Filter by agreements whose last date to terminate is on or after the provided date. Default: null Format: date |
min_last_date_to_terminate (anyOf 2) | null | Alternative | |
min_start_date | JSON | Optional | |
min_start_date (anyOf 1) | string | Alternative | Filter by agreements whose start date is on or after the provided date. Default: null Format: date |
min_start_date (anyOf 2) | null | Alternative | |
min_total_value | JSON | Optional | |
min_total_value (anyOf 1) | JSON | Alternative | Filter by agreements with total value greater than or equal to this value. Default: null |
min_total_value (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
min_total_value (anyOf 1) (oneOf 2) | number | Alternative | |
min_total_value (anyOf 2) | null | Alternative | |
page_size | integer | Optional | The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used. Default: 20 |
payee_agreement_ids | JSON | Optional | |
payee_agreement_ids (anyOf 1) | array | Alternative | Filter by agreement IDs. |
payee_agreement_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_agreement_ids (anyOf 2) | null | Alternative | |
payee_ids | JSON | Optional | |
payee_ids (anyOf 1) | array | Alternative | Filter by vendor (payee) IDs. |
payee_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_ids (anyOf 2) | null | Alternative | |
payee_owner_ids | JSON | Optional | |
payee_owner_ids (anyOf 1) | array | Alternative | Filter by vendor owner IDs. |
payee_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_owner_ids (anyOf 2) | null | Alternative | |
renewal_status | JSON | Optional | |
renewal_status (anyOf 1) | array | Alternative | Filter by agreement renewal status. |
renewal_status (anyOf 1)[] | string | Each item | One of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
renewal_status (anyOf 2) | null | Alternative | |
renewal_status_exclude | JSON | Optional | |
renewal_status_exclude (anyOf 1) | array | Alternative | Exclude agreements with these renewal statuses. |
renewal_status_exclude (anyOf 1)[] | string | Each item | One of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
renewal_status_exclude (anyOf 2) | null | Alternative | |
start | string | Optional | The ID of the last entity of the previous page, used for pagination to get the next page. |
start_date_range | JSON | Optional | |
start_date_range (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body end date range end, start JSON object describing a relative start date range filter. |
start_date_range (anyOf 2) | null | Alternative |
Referenced models: List vendor agreements — request body — body agreement custom records type and, List vendor agreements — request body — body end date range end, start