Skip to content

Brex: List Budget Programs

Brex budgets.budgetsListBudgetPrograms: arguments, response, policy and SDK examples.

← Budgets operations · Get started

Operation brex.budgets_listbudgetprograms

Provider route: GET /v1/budget_programs. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["budgets"]["budgetsListBudgetPrograms"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.budgets.budgetsListBudgetPrograms(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_brex import BrexIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.budgets.budgets_list_budget_programs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorJSONOptional
query.cursor (anyOf 1)stringAlternative
query.cursor (anyOf 2)nullAlternative
query.limitJSONOptional
query.limit (anyOf 1)integerAlternativeFormat: int32
query.limit (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List Budget Programs — response body

Referenced models: List Budget Programs — response body

List Budget Programs — response body
FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get Budget Program — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get Budget Program — response body

Get Budget Program — response body
FieldTypePresenceDescription and constraints
$objectRoot
Budget Program used to create Spend Limits for eligible users.
budget_blueprintsarrayRequired within parent
budget_blueprints[]ModelEach itemExpand Get Budget Program — response body — budget blueprints item
budget_program_statusstringRequired within parentKnown values: BUDGET_PROGRAM_STATUS_ACTIVE, BUDGET_PROGRAM_STATUS_INACTIVE, BUDGET_PROGRAM_STATUS_DELETED
created_atstringRequired within parentFormat: date
creator_user_idJSONOptional
creator_user_id (anyOf 1)stringAlternative
creator_user_id (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
employee_filterJSONOptional
employee_filter (anyOf 1)JSONAlternative
employee_filter (anyOf 1) (allOf 1)ModelAll variants applyExpand Get Budget Program — response body — employee filter employment status, employment type employment status, employment type
employee_filter (anyOf 2)nullAlternative
existing_budget_idsJSONOptional
existing_budget_ids (anyOf 1)arrayAlternative
IDs for existing Spend Limits associated with this Budget Program.
existing_budget_ids (anyOf 1)[]stringEach item
existing_budget_ids (anyOf 2)nullAlternative
idstringRequired within parent
namestringRequired within parent
updated_atstringRequired within parentFormat: date

Referenced models: Get Budget Program — response body — budget blueprints item, Get Budget Program — response body — employee filter employment status, employment type employment status, employment type

Get Budget Program — response body — budget blueprints item
FieldTypePresenceDescription and constraints
$objectRoot
Blueprint for provisioning Spend Limits for a Budget Program.
descriptionJSONOptional
description (anyOf 1)stringAlternative
Description of what the Spend Limit is used for.
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternative
The UTC date when the Spend Limit should stop counting.

Format: date
end_date (anyOf 2)nullAlternative
idstringRequired within parent
limitJSONOptional
limit (anyOf 1)JSONAlternative
limit (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
limit (anyOf 2)nullAlternative
limit_typestringRequired within parent
Whether the Spend Limit's limit blocks spend.

Known values: HARD, SOFT
limit_visibilitystringRequired within parent
Determines if Spend Limit members are allowed to view the Spend Limit's limit.

Known values: SHARED, PRIVATE
namestringRequired within parent
Name for the Spend Limit.
owner_user_idsarrayRequired within parent
User IDs of the owners of the Spend Limit.
owner_user_ids[]stringEach item
parent_budget_idstringRequired within parent
ID of parent Budget.
period_typestringRequired within parent
Period type of the Spend Limit e.g. MONTHLY.

Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME
spend_typestringRequired within parent
Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit.

Known values: BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED
start_dateJSONOptional
start_date (anyOf 1)stringAlternative
The UTC date when the Spend Limit should start counting.

Format: date
start_date (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount

Get Budget Program — response body — employee filter employment status, employment type employment status, employment type
FieldTypePresenceDescription and constraints
$objectRoot
A filter used to determine if a user adheres to a Budget Program.
employment_statusJSONOptional
employment_status (anyOf 1)JSONAlternative
employment_status (anyOf 1) (allOf 1)stringAll variants apply
A filter used to determine if a user adheres to a Budget Program.

Known values: EMPLOYMENT_STATUS_ACTIVE, EMPLOYMENT_STATUS_INACTIVE, EMPLOYMENT_STATUS_PENDING
employment_status (anyOf 2)nullAlternative
employment_typeJSONOptional
employment_type (anyOf 1)JSONAlternative
employment_type (anyOf 1) (allOf 1)stringAll variants apply
What kind of employment the employee has.

Known values: EMPLOYMENT_TYPE_FULL_TIME, EMPLOYMENT_TYPE_PART_TIME, EMPLOYMENT_TYPE_CONTRACTOR, EMPLOYMENT_TYPE_INTERN, EMPLOYMENT_TYPE_FREELANCE
employment_type (anyOf 2)nullAlternative
Get transfer — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination
of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Format: int64
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative

SDK function policy ID: brex.budgets_listbudgetprograms. Catalog operation: budgets:listBudgetPrograms. 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: ["budgets", "budgets.readonly"]

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.