Ramp: List unified requests with pagination
Ramp unifiedRequest.getUnifiedRequestListWithPagination: arguments, response, policy and SDK examples.
← unified_request operations · Get started · OpenAPI downloads
Contract 2026-10-27 · Operation ramp.get_unified_request_list_with_pagination
Provider route: GET /developer/v1/unified-requests. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.department_ids | JSON | Optional | |
query.department_ids (anyOf 1) | array | Alternative | |
query.department_ids (anyOf 1)[] | string | Each item | Format: uuid |
query.department_ids (anyOf 2) | null | Alternative | |
query.entity_ids | JSON | Optional | |
query.entity_ids (anyOf 1) | array | Alternative | |
query.entity_ids (anyOf 1)[] | string | Each item | Format: uuid |
query.entity_ids (anyOf 2) | null | Alternative | |
query.location_ids | JSON | Optional | |
query.location_ids (anyOf 1) | array | Alternative | |
query.location_ids (anyOf 1)[] | string | Each item | Format: uuid |
query.location_ids (anyOf 2) | null | Alternative | |
query.owner_user_ids | JSON | Optional | |
query.owner_user_ids (anyOf 1) | array | Alternative | |
query.owner_user_ids (anyOf 1)[] | string | Each item | Format: uuid |
query.owner_user_ids (anyOf 2) | null | Alternative | |
query.spend_program_ids | JSON | Optional | |
query.spend_program_ids (anyOf 1) | array | Alternative | |
query.spend_program_ids (anyOf 1)[] | string | Each item | Format: uuid |
query.spend_program_ids (anyOf 2) | null | Alternative | |
query.spend_request_types | JSON | Optional | |
query.spend_request_types (anyOf 1) | array | Alternative | |
query.spend_request_types (anyOf 1)[] | string | Each item | One of: APPROVAL_ONLY, FUND_UNARCHIVE, PURCHASE_ORDER, SPEND_LIMIT, TRAVEL |
query.spend_request_types (anyOf 2) | null | Alternative | |
query.request_statuses | JSON | Optional | |
query.request_statuses (anyOf 1) | array | Alternative | |
query.request_statuses (anyOf 1)[] | string | Each item | One of: APPROVED, DRAFT, PENDING, REJECTED |
query.request_statuses (anyOf 2) | null | Alternative | |
query.unified_spend_request_types | JSON | Optional | |
query.unified_spend_request_types (anyOf 1) | array | Alternative | |
query.unified_spend_request_types (anyOf 1)[] | string | Each item | One of: APPROVAL_ONLY, FUND_UNARCHIVE, PROCUREMENT_SPEND_ALLOCATION, PURCHASE_ORDER, SPEND_ALLOCATION, TRAVEL |
query.unified_spend_request_types (anyOf 2) | null | Alternative | |
query.include_deleted | boolean | Optional | Default: false |
query.min_amount | JSON | Optional | |
query.min_amount (anyOf 1) | JSON | Alternative | |
query.min_amount (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
query.min_amount (anyOf 1) (oneOf 2) | number | Alternative | |
query.min_amount (anyOf 2) | null | Alternative | |
query.max_amount | JSON | Optional | |
query.max_amount (anyOf 1) | JSON | Alternative | |
query.max_amount (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
query.max_amount (anyOf 1) (oneOf 2) | number | Alternative | |
query.max_amount (anyOf 2) | null | Alternative | |
query.from_created_at | JSON | Optional | |
query.from_created_at (anyOf 1) | string | Alternative | Format: date-time |
query.from_created_at (anyOf 2) | null | Alternative | |
query.to_created_at | JSON | Optional | |
query.to_created_at (anyOf 1) | string | Alternative | Format: date-time |
query.to_created_at (anyOf 2) | null | Alternative | |
query.start | string | Optional | |
query.page_size | integer | Optional | Default: 20 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand List unified requests with pagination — response body — item |
Referenced models: List unified requests with pagination — response body — item
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]