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.
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["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 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.approvals.get_approvals_list(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.start | string | Optional | |
query.page_size | integer | Optional | Default: 20 |
query.entity_type | string | Required within parent | One of: BILL, REIMBURSEMENT, TRANSACTION |
query.entity_ids | array | Required within parent | |
query.entity_ids[] | string | Each item | Format: uuid |
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 |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”List approval data for a set of Transactions, Reimbursements, or Bills — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Approval details for a resource. |
approval_history | array | Required within parent | Actions recorded for the approval chain. Read only: true |
approval_history[] | Model | Each item | Expand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item approval history item |
entity_id | string | Required within parent | Unique identifier of the resource. Format: uuid Read only: true |
entity_type | string | Required within parent | Type of resource under approval. Known values: bill, reimbursement, transaction Read only: true |
next_approvers | array | Required within parent | Users responsible for the next approval action. Read only: true |
next_approvers[] | Model | Each item | Expand List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item |
status | string | Required within parent | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An action recorded in an approval's history. |
action_at | string | Required within parent | Date and time when the action occurred. Format: date-time |
step_status | string | Required within parent | Resulting status of the approval step. |
user_email | JSON | Required within parent | |
user_email (anyOf 1) | string | Alternative | Email address of the acting user. Format: email |
user_email (anyOf 2) | null | Alternative | |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | Unique identifier of the acting user. Format: uuid |
user_id (anyOf 2) | null | Alternative |
List approval data for a set of Transactions, Reimbursements, or Bills — response body — data item next approvers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user responsible for the next approval action. |
user_email | string | Required within parent | Email address of the next approver. Format: email |
user_id | string | Required within parent | Unique identifier of the next approver. Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]