Skip to content

Ramp: List unified requests with pagination

Ramp unifiedRequest.getUnifiedRequestListWithPagination: arguments, response, policy and SDK examples.

← Unified request operations · Get started

Operation ramp.get_unified_request_list_with_pagination

Provider route: GET /developer/v1/unified-requests. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["unifiedRequest"]["getUnifiedRequestListWithPagination"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.unifiedRequest.getUnifiedRequestListWithPagination(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.unified_request.get_unified_request_list_with_pagination(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.department_idsJSONOptional
query.department_ids (anyOf 1)arrayAlternative
query.department_ids (anyOf 1)[]stringEach itemFormat: uuid
query.department_ids (anyOf 2)nullAlternative
query.entity_idsJSONOptional
query.entity_ids (anyOf 1)arrayAlternative
query.entity_ids (anyOf 1)[]stringEach itemFormat: uuid
query.entity_ids (anyOf 2)nullAlternative
query.location_idsJSONOptional
query.location_ids (anyOf 1)arrayAlternative
query.location_ids (anyOf 1)[]stringEach itemFormat: uuid
query.location_ids (anyOf 2)nullAlternative
query.owner_user_idsJSONOptional
query.owner_user_ids (anyOf 1)arrayAlternative
query.owner_user_ids (anyOf 1)[]stringEach itemFormat: uuid
query.owner_user_ids (anyOf 2)nullAlternative
query.spend_program_idsJSONOptional
query.spend_program_ids (anyOf 1)arrayAlternative
query.spend_program_ids (anyOf 1)[]stringEach itemFormat: uuid
query.spend_program_ids (anyOf 2)nullAlternative
query.spend_request_typesJSONOptional
query.spend_request_types (anyOf 1)arrayAlternative
query.spend_request_types (anyOf 1)[]stringEach itemOne of: APPROVAL_ONLY, FUND_UNARCHIVE, PURCHASE_ORDER, SPEND_LIMIT, TRAVEL
query.spend_request_types (anyOf 2)nullAlternative
query.request_statusesJSONOptional
query.request_statuses (anyOf 1)arrayAlternative
query.request_statuses (anyOf 1)[]stringEach itemOne of: APPROVED, DRAFT, PENDING, REJECTED
query.request_statuses (anyOf 2)nullAlternative
query.unified_spend_request_typesJSONOptional
query.unified_spend_request_types (anyOf 1)arrayAlternative
query.unified_spend_request_types (anyOf 1)[]stringEach itemOne of: APPROVAL_ONLY, FUND_UNARCHIVE, PROCUREMENT_SPEND_ALLOCATION, PURCHASE_ORDER, SPEND_ALLOCATION, TRAVEL
query.unified_spend_request_types (anyOf 2)nullAlternative
query.include_deletedbooleanOptionalDefault: false
query.min_amountJSONOptional
query.min_amount (anyOf 1)JSONAlternative
query.min_amount (anyOf 1) (oneOf 1)stringAlternativeFormat: decimal
query.min_amount (anyOf 1) (oneOf 2)numberAlternative
query.min_amount (anyOf 2)nullAlternative
query.max_amountJSONOptional
query.max_amount (anyOf 1)JSONAlternative
query.max_amount (anyOf 1) (oneOf 1)stringAlternativeFormat: decimal
query.max_amount (anyOf 1) (oneOf 2)numberAlternative
query.max_amount (anyOf 2)nullAlternative
query.from_created_atJSONOptional
query.from_created_at (anyOf 1)stringAlternativeFormat: date-time
query.from_created_at (anyOf 2)nullAlternative
query.to_created_atJSONOptional
query.to_created_at (anyOf 1)stringAlternativeFormat: date-time
query.to_created_at (anyOf 2)nullAlternative
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand List unified requests with pagination — response body — item

Referenced models: List unified requests with pagination — response body — item

47 more schemas are linked from the tables above, on the schema pages.

List unified requests with pagination — response body — item
FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"SPEND_REQUEST": "#/components/schemas/UnifiedSpendRequest"}, "propertyName": "unified_request_type"}
$ (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item value

Referenced models: List unified requests with pagination — response body — item value

List unified requests with pagination — response body — item value
FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"APPROVAL_ONLY": "#/components/schemas/ApprovalOnlyRequest", "FUND_UNARCHIVE": "#/components/schemas/FundUnarchiveRequest", "PROCUREMENT_SPEND_ALLOCATION": "#/components/schemas/ProcurementSpendAllocationRequest", "PURCHASE_ORDER": "#/components/schemas/PurchaseOrderRequest", "SPEND_ALLOCATION": "#/components/schemas/SpendAllocationRequest", "TRAVEL": "#/components/schemas/TravelRequest"}, "propertyName": "unified_spend_request_type"}
$ (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY
$ (anyOf 2)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE
$ (anyOf 3)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION
$ (anyOf 4)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER
$ (anyOf 5)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION
$ (anyOf 6)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: PROCUREMENT SPEND ALLOCATION, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, restricted request type: SPEND ALLOCATION, spend request type: SPEND LIMIT, unified request type: SPEND REQUEST, unified spend request type: SPEND ALLOCATION, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY
Default: APPROVAL_ONLY
$ (allOf 2).unified_spend_request_typestringRequired within parentKnown values: APPROVAL_ONLY
Default: APPROVAL_ONLY

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: FUND UNARCHIVE, unified request type: SPEND REQUEST, unified spend request type: FUND UNARCHIVE
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST
$ (allOf 2)objectAll variants apply
$ (allOf 2).blank_canvas_execution_idJSONRequired within parent
$ (allOf 2).blank_canvas_execution_id (anyOf 1)stringAlternativeBlank Canvas execution for this restoration request's approvals, or null.
Format: uuid
Read only: true
$ (allOf 2).blank_canvas_execution_id (anyOf 2)nullAlternative
$ (allOf 2).existing_spend_requestJSONRequired within parent
$ (allOf 2).existing_spend_request (anyOf 1)ModelAlternativeExpand List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type
The original fund request linked to this restoration request.
$ (allOf 2).existing_spend_request (anyOf 2)nullAlternative
$ (allOf 2).spend_request_typestringRequired within parentPersisted request type for restoring an existing fund.
Known values: FUND_UNARCHIVE
Default: FUND_UNARCHIVE
$ (allOf 2).unified_spend_request_typestringRequired within parentUnified request classification for fund restoration, not new funding.
Known values: FUND_UNARCHIVE
Default: FUND_UNARCHIVE

Referenced models: List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: APPROVAL ONLY, unified request type: SPEND REQUEST, unified spend request type: APPROVAL ONLY spend request type: APPROVAL ONLY, unified spend request type: APPROVAL ONLY existing spend request id, is shareable, lock date, post spend approval instance policy, spend eligibility starts at, spend frequency, unified request id, unified spend request type, List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: TRAVEL, unified request type: SPEND REQUEST, unified spend request type: TRAVEL request status: APPROVED, DRAFT, REJECTED, SUBMITTED, unified request type: SPEND REQUEST

List unified requests with pagination — response body — item / value / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, spend request type: PURCHASE ORDER, unified request type: SPEND REQUEST, unified spend request type: PURCHASE ORDER spend request type: PURCHASE ORDER, unified spend request type: PURCHASE ORDER purchase order
FieldTypePresenceDescription and constraints
$objectRoot
can_view_full_purchase_orderbooleanRequired within parentWhether the acting user can open the full purchase order.
Read only: true
idstringRequired within parentFormat: uuid
is_directly_issuedbooleanRequired within parentTrue when the PO was issued directly, without a program or request approval.
purchase_order_numberJSONRequired within parent
purchase_order_number (anyOf 1)stringAlternativeRead only: true
purchase_order_number (anyOf 2)nullAlternative

SDK function policy ID: ramp.get_unified_request_list_with_pagination. Catalog operation: get_unified_request_list_with_pagination. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["unified_requests:read"]

Official provider source

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.