Skip to content

Ramp: List approval data for a set of Transactions, Reimbursements, or Bills

Ramp approvals.getApprovalsList: arguments, response, policy and SDK examples.

← Approvals operations · Get started

Operation ramp.get_approvals_list

Provider route: GET /developer/v1/approvals. 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["approvals"]["getApprovalsList"]>[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.approvals.getApprovalsList(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.approvals.get_approvals_list(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20
query.entity_typestringRequired within parentOne of: BILL, REIMBURSEMENT, TRANSACTION
query.entity_idsarrayRequired within parent
query.entity_ids[]stringEach itemFormat: uuid

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body

Referenced models: List approval data for a set of Transactions, Reimbursements, or Bills — response body

List approval data for a set of Transactions, Reimbursements, or Bills — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item

List bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item
FieldTypePresenceDescription and constraints
$objectRootApproval details for a resource.
approval_historyarrayRequired within parentActions recorded for the approval chain.
Read only: true
approval_history[]ModelEach itemExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item
entity_idstringRequired within parentUnique identifier of the resource.
Format: uuid
Read only: true
entity_typestringRequired within parentType of resource under approval.
Known values: bill, reimbursement, transaction
Read only: true
next_approversarrayRequired within parentUsers responsible for the next approval action.
Read only: true
next_approvers[]ModelEach itemExpand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item
statusstringRequired within parentCurrent status of the approval chain.
Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED

Referenced models: List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item, List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item

List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item
FieldTypePresenceDescription and constraints
$objectRootAn action recorded in an approval's history.
action_atstringRequired within parentDate and time when the action occurred.
Format: date-time
step_statusstringRequired within parentResulting status of the approval step.
user_emailJSONRequired within parent
user_email (anyOf 1)stringAlternativeEmail address of the acting user.
Format: email
user_email (anyOf 2)nullAlternative
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeUnique identifier of the acting user.
Format: uuid
user_id (anyOf 2)nullAlternative
List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item
FieldTypePresenceDescription and constraints
$objectRootA user responsible for the next approval action.
user_emailstringRequired within parentEmail address of the next approver.
Format: email
user_idstringRequired within parentUnique identifier of the next approver.
Format: uuid

SDK function policy ID: ramp.get_approvals_list. Catalog operation: get_approvals_list. 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: ["approvals: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.