Skip to content

Ramp: List Ramp users with estimated AI spend during the requested period

Ramp aiSpend.getAiSpendTeamListResource: arguments, response, policy and SDK examples.

← AI spend operations · Get started

Operation ramp.get_ai_spend_team_list_resource

Provider route: GET /developer/v1/ai-spend/team. 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["aiSpend"]["getAiSpendTeamListResource"]>[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.aiSpend.getAiSpendTeamListResource(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.ai_spend.get_ai_spend_team_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.providersarrayOptional
query.providers[]stringEach itemOne of: ANTHROPIC, CURSOR, FIREWORKS, OPENAI, RAMP
query.to_datestringRequired within parentFormat: date
query.is_anomalousbooleanOptional
query.page_sizeintegerOptionalDefault: 20
Maximum: 100
Minimum: 2
query.startstringOptionalMinimum length: 1
query.from_datestringRequired within parentFormat: date

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List Ramp users with estimated AI spend during the requested period — response body

Referenced models: List Ramp users with estimated AI spend during the requested period — response body

List Ramp users with estimated AI spend during the requested period — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentRamp users and their AI spend.
data[]ModelEach itemExpand List Ramp users with estimated AI spend during the requested period — 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 Ramp users with estimated AI spend during the requested period — 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 Ramp users with estimated AI spend during the requested period — response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
department_nameJSONRequired within parent
department_name (anyOf 1)stringAlternativeCurrent Ramp department name, when available.
department_name (anyOf 2)nullAlternative
emailstringRequired within parentRamp user email.
Format: email
estimated_costModelRequired within parentExpand Fetch a payment — response body — amount
Usage-derived estimated cost for the requested period.
Read only: true
estimated_cost_by_providerarrayRequired within parentEstimated cost split by AI provider.
estimated_cost_by_provider[]ModelEach itemExpand List Ramp users with estimated AI spend during the requested period — response body — data item estimated cost by provider item
first_namestringRequired within parentRamp user first name.
idstringRequired within parentUnique Ramp user identifier.
Format: uuid
is_anomalousbooleanRequired within parentWhether Ramp detected anomalous AI spend for the user during the requested period.
is_ramp_userbooleanRequired within parentWhether the person is a Ramp user. Always true for records returned by this endpoint.
last_namestringRequired within parentRamp user last name.
user_statusstringRequired within parentCurrent Ramp user lifecycle status.
Known values: active, deleted, draft, inactive, pending
Read only: true

Referenced models: List Ramp users with estimated AI spend during the requested period — response body — data item estimated cost by provider item, Fetch a payment — response body — amount

List Ramp users with estimated AI spend during the requested period — response body — data item estimated cost by provider item
FieldTypePresenceDescription and constraints
$objectRoot
estimated_costModelRequired within parentExpand Fetch a payment — response body — amount
Usage-derived estimated cost for this provider.
Read only: true
providerstringRequired within parentAI provider attributed to this estimated cost.
Known values: ANTHROPIC, CURSOR, FIREWORKS, OPENAI, RAMP
Read only: true

Referenced models: Fetch a payment — response body — amount

Fetch a payment — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentThe currency of the amount in ISO 4217 format (e.g. USD).
Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
valueJSONRequired within parent
value (anyOf 1)integerAlternativeThe non-negative amount in the smallest denomination of the currency (e.g. cents for USD).
Minimum: 0
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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