Skip to main content
Brex logo
  • Category: accounting
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 84
  • Triggers: 0
  • Slug: BREX
  • Version: 20261101_00

Tools

Slug: BREX_ADD_WEBHOOK_GROUP_MEMBERSAdd webhook subscription members to a webhook group. This action associates one or more webhook subscriptions with an existing webhook group, allowing those subscriptions to receive events targeted at the group. Note: Webhook groups are only available for Brex partner accounts. Requires an existing webhook group ID and valid webhook subscription IDs. Use this when you need to organize webhook subscriptions into groups for easier management of webhook events across multiple subscriptions.

Input Parameters

string
required
The ID of the webhook group to add members to. This should be a webhook group ID starting with ‘wg_’.
array
required
List of webhook subscriptions to add to the group. Each member should have a member_id (webhook subscription ID) and member_type (‘ACCOUNT’). At least one member is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_ARCHIVE_BUDGETArchive a budget to mark it as inactive and prevent future expenses. Archives the specified budget, making it unusable for new transactions and removing it from active budget lists in the UI. This action is permanent and cannot be undone.

Input Parameters

string
required
ID of the budget to archive. Once archived, the budget will be marked as inactive and cannot be used for future expenses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_ARCHIVE_SPEND_LIMITArchive a spend limit in Brex. Archives an existing spend limit to remove it from active use, making it unusable for future expenses and hiding it from the UI. Once archived, the spend limit cannot be used to authorize new transactions.

Input Parameters

string
required
Unique identifier of the spend limit to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_BUDGETCreate a new budget for a department or project under an existing parent budget.

Input Parameters

string
required
Name for the budget.
string
required
Description of the budget.
object
required
Budget amount and currency.
array
List of user IDs who own this budget.
string
required
Parent budget ID. All budgets must be sub-budgets of an existing budget.
string
Budget period recurrence type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_BUDGET_V1Tool to create a new Spend Limit (Budget) in Brex. Use when you need to set up spending controls with specific limits, visibility settings, and period types.

Input Parameters

string
required
Name for the Spend Limit.
object
required
The spending limit amount and currency for this budget.
string
The UTC date when the Spend Limit should stop counting, in YYYY-MM-DD format.
string
Optional entity ID to associate with this budget.
string
Optional policy ID to associate with this budget.
string ("HARD" | "SOFT")
required
Whether the Spend Limit’s limit blocks spend. HARD limits block transactions when exceeded, SOFT limits allow overspending but provide warnings.
string ("BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED")
required
Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. BUDGET_PROVISIONED_CARDS_ONLY restricts spending to cards created under this budget, while NON_BUDGET_PROVISIONED_CARDS_ALLOWED permits other cards to use this budget.
string
The UTC date when the Spend Limit should start counting, in YYYY-MM-DD format.
string
required
Description of what the Spend Limit is used for.
string ("WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME")
required
Period type of the Spend Limit. Options: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME.
array
User IDs of the owners of the Spend Limit. Owners have full control over the budget.
string
Idempotency key for the request. For retry safety, clients should generate, store, and reuse the same key when retrying failed operations. If not provided, a UUID will be auto-generated. Recommended format: V4 UUID.
array
User IDs of the members of the Spend Limit. Members can spend from the budget but may have restricted visibility/control.
string ("SHARED" | "PRIVATE")
required
Determines if Spend Limit members are allowed to view the Spend Limit’s limit. SHARED makes the limit visible to all members, PRIVATE hides it.
string
required
ID of parent Budget. All budgets must have a parent budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_CARDCreate a new card and assign it to a user.

Input Parameters

string
required
Display name for the card.
string ("VIRTUAL" | "PHYSICAL")
Type of card to create. Note: PHYSICAL cards require limit_type=‘USER’ (card-level limits not allowed for physical cards).
string ("CARD" | "USER")
Type of spend limit. ‘CARD’ sets card-specific limits (requires spend_controls, only valid for VIRTUAL cards). ‘USER’ inherits the user’s spend limit.
string
required
User ID of the card owner.
object
Spend control settings for card creation. Required when limit_type is ‘CARD’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_DEPARTMENTCreate a new department.

Input Parameters

string
required
Name of the department
string
Description of the department

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_DOCUMENTCreate a document upload URL for a referral and return a pre-signed S3 upload URL. Use this tool when you need to upload supporting documents for a business referral application. The tool returns a pre-signed S3 URL that can be used to upload document files (PDF, JPG, PNG, etc.) up to 50 MB. The pre-signed URL expires 30 minutes after creation and can only be used for a PUT operation. Supported document types: - ARTICLES_OF_INCORPORATION: Company incorporation documents - IRS_EIN_CONFIRMATION: IRS CP 575 or 147C form (EIN confirmation letter) - IRS_EIN_APPLICATION: IRS SS4 form (Application for Employer Identification Number) - CERTIFICATE_GOOD_STANDING: Certificate of good standing from the state

Input Parameters

string
required
The unique identifier of the referral to upload documents for. This must be a valid referral ID from the Brex system.
string ("ARTICLES_OF_INCORPORATION" | "IRS_EIN_CONFIRMATION" | "IRS_EIN_APPLICATION" | "CERTIFICATE_GOOD_STANDING")
required
Type of document being submitted. ARTICLES_OF_INCORPORATION for company incorporation documents, IRS_EIN_CONFIRMATION for IRS CP 575 or 147C form, IRS_EIN_APPLICATION for IRS SS4 form, or CERTIFICATE_GOOD_STANDING for certificate of good standing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_EXPENSECreate a new expense.

Input Parameters

string
required
Memo for the expense
object
required
Expense amount and currency
string
required
User ID of the expense owner

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_FIELDCreate a new custom field in Brex. Use when you need to add custom metadata fields for accounting or ERP integrations. Fields can be associated with specific integrations and can be enabled or disabled as needed.

Input Parameters

string
required
The name of the field
string ("ACCOUNTING" | "ERP")
required
Field group category. Must be either ACCOUNTING or ERP.
string
Remote/external ID of custom field from external system (e.g. ERP or HRIS system)
boolean
Indicates if the field is disabled. If true, the field will not be available for use.
string
Integration ID to associate this field with a specific integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_FIELD_VALUESCreate custom field values for a specific Brex field. Use when you need to add new dropdown options or values to a custom field (up to 1000 values per request). This action allows you to bulk-create field values for custom fields in Brex. Custom fields are used throughout Brex for categorizing expenses, cards, budgets, and other entities. Each value can have a custom ID, be marked as disabled, and include an external system reference for integrations.

Input Parameters

array
required
List of field values to be created. Must contain at least 1 item and no more than 1000 items
string
required
The Field Brex identifier. This is the unique ID of the custom field for which you want to create values
string
Idempotency key for this request. If not provided, a UUID will be auto-generated. Use this to safely retry requests without creating duplicate values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_LOCATIONCreate a new location.

Input Parameters

string
required
Name of the location
string
Description of the location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_REFERRAL_REQUESTTool to create a new referral to Brex for onboarding. Use when you want to refer a prospect to Brex and get a personalized application link. The response contains a unique referral ID and a personalized signup URL. Many fields are optional; when provided, they prefill the application form for the prospect. The referral link expires after a certain time period.

Input Parameters

object
Business details for the referral application.
object
required
Required information about the referred prospect including email, first name, and last name.
string
required
Referral code that attributes credit to you if the prospect signs up for a Brex account.
string
Optional contact preference for the referral. Use ‘EMAIL_OUTBOUND’ if Brex should email the customer directly, or ‘NO_OUTBOUND’ if partner will contact (default).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_SPEND_LIMITTool to create a spend limit in Brex. Use when you need to establish spending controls with authorization settings, visibility rules, and policy associations. Requires expense policy ID and authorization settings. Optionally link to parent budget.

Input Parameters

string
required
Name for the Spend Limit.
string
The date when the Spend Limit should expire (format: YYYY-MM-DD).
string ("NON_BUDGET_PROVISIONED_CARDS_ALLOWED" | "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ONLY")
required
Type of spending allowed under this limit.
string
The date when the Spend Limit should start counting (format: YYYY-MM-DD).
string
Description of what the Spend Limit is used for.
string
The department ID to which Spend Limit expenses will be attributed.
array
User IDs of the owners of the Spend Limit.
string
Optional idempotency key for the request. If not provided, a random UUID will be generated.
The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity.
array
User IDs of the members of the Spend Limit.
string
ID of parent Budget. Required if not creating a root budget.
string
required
The ID of the expense policy corresponding to this Spend Limit.
object
Transaction limit for the spend limit.
string ("PRIVATE" | "PUBLIC")
required
Expense visibility setting: ‘PRIVATE’ or ‘PUBLIC’.
object
required
Authorization settings including limit amount and type.
string ("ENABLED" | "DISABLED")
required
Setting to allow or disallow limit increase requests.
string ("PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | "ONE_TIME")
required
Period recurrence type for the spend limit.
string ("PRIVATE" | "PUBLIC")
required
Authorization visibility setting: ‘PRIVATE’ or ‘PUBLIC’.
string
The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.
string ("ENABLED" | "DISABLED")
required
Setting to enable or disable automatic card transfers.
string ("ENABLED" | "DISABLED")
required
Setting to enable or disable automatic card creation for this limit.
string
The ID of the policy for limit increase requests for this Spend Limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_TITLECreate a new job title.

Input Parameters

string
required
Name of the job title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_USERCreate a new user in the Brex account.

Input Parameters

string
required
Email address of the user
string
required
Last name of the user
string
required
First name of the user
string
User ID of the manager (optional). This should be the ID of an existing user in the system.
string
Department ID to assign the user to (optional). This should be the ID of an existing department in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_VENDORCreate a new vendor in Brex for payment operations. The vendor company name must be unique within your Brex account - attempting to create a vendor with a duplicate name will result in an error. You can optionally include contact information (email, phone) and payment account details (ACH, wire transfer, or check) at creation time. Returns a vendor ID that can be used in transfer operations and other vendor-related actions.

Input Parameters

string
Email address for the vendor.
string
Phone number for the vendor.
string
required
Name for the vendor. The name must be unique.
array
Payment accounts to associate with the vendor. Each account contains payment details based on the payment type (ACH, wire transfer, or check).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_WEBHOOK_GROUPTool to create a webhook group for targeting webhook subscriptions. Use when you need to create a webhook group to organize webhook subscriptions for specific members. Webhook groups are only available for partners.

Input Parameters

string
required
The name for the webhook group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_CREATE_WEBHOOK_SUBSCRIPTIONRegister a new webhook subscription to receive real-time notifications for Brex events. This allows you to be notified via HTTPS POST requests when events occur, such as USER_UPDATED, EXPENSE_PAYMENT_UPDATED, TRANSFER_PROCESSED, TRANSFER_FAILED, and others. Note: Currently only one webhook endpoint can be registered per customer/client_id, though each endpoint can handle multiple event types. Requires ‘openid’ and ‘offline_access’ OAuth scopes, plus event-specific scopes (e.g., ‘expenses.card.readonly’ for EXPENSE_PAYMENT_UPDATED).

Input Parameters

string
required
The URL to which webhook events will be sent. Must be a valid, publicly accessible HTTPS URL that can receive POST requests with webhook event payloads.
string
ID of the webhook group to which this subscription applies. This is only available for partners. Leave empty for subscriptions not tied to a specific group.
array
required
A list of the webhook event types this subscription will listen to. Must contain at least one event type. Valid event types include: REFERRAL_CREATED, REFERRAL_ACTIVATED, REFERRAL_APPLICATION_STATUS_CHANGED, TRANSFER_PROCESSED, TRANSFER_FAILED, USER_UPDATED, EXPENSE_PAYMENT_UPDATED, and others. Refer to Brex API documentation for the complete list of supported event types and their required scopes.
string
required
Unique idempotency key to ensure the request is processed only once. Use a unique value for each subscription creation attempt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_DELETE_FIELDTool to delete a custom field by Brex ID. Use when you need to permanently remove a custom field from the system.

Input Parameters

string
required
The Brex identifier of the field to delete. This is the field ID that was returned when the field was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_DELETE_FIELD_VALUESDelete custom field values for a specific field. You can delete up to 1000 values at once. Each value must be identified by exactly one of: brex_id (Brex-generated ID), value_id (value identifier), or remote_id (external system ID). Use this when you need to bulk delete field values from a custom field.

Input Parameters

array
required
List of field values to delete. Each item must contain exactly one identifier (brex_id, value_id, or remote_id). Maximum 1000 items allowed.
string
required
The Field Brex identifier. This is the unique ID of the field whose values you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_DELETE_VENDORDelete a vendor by ID. Use this when you need to remove a vendor from the system. The vendor must exist and not have any pending transactions or dependencies.

Input Parameters

string
required
Unique identifier of the vendor to delete. This is the vendor ID that was returned when the vendor was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_ACCOUNT_STATEMENTSGet finalized statements for the primary cash account. Returns statement history including start and end balances for each statement period.

Input Parameters

integer
Maximum number of statements to return. Valid range: 1-1000.
string
Pagination cursor returned from a previous request. Leave empty for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_BUDGET_DETAILSGet detailed information about a specific budget. This action retrieves comprehensive budget details including balance, limits, ownership, and period information from the Brex v2 Budgets API.

Input Parameters

string
required
ID of the budget to get details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_CARD_DETAILSGet detailed information about a specific card.

Input Parameters

string
required
The unique identifier of the card. Use the List Cards action to retrieve available card IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_CARD_EXPENSETool to retrieve detailed information about a specific card expense by its ID. Use when you need to get comprehensive details about a card transaction, including merchant information, amounts, status, and other expense metadata. Supports expanding additional fields like merchant MCC code, location, department, user, budget, and payment details.

Input Parameters

array
List of fields to expand in the response. Available options: ‘location’, ‘department’, ‘merchant’, ‘receipts.download_uris’, ‘user’, ‘budget’, ‘payment’. When specified, additional details for these fields will be included in the response.
string
required
Unique ID of the card expense to retrieve.
boolean
If true, custom fields associated with the expense will be included in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_CARD_NUMBERGet card number, CVV, and expiration date for a specific card.

Input Parameters

string
required
ID of the card to get number details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_CARD_TRANSACTIONSGet settled card transactions for the primary card account. Returns purchases, refunds, and chargebacks that have been posted/settled. Use the next_cursor field in the response for pagination to retrieve additional results. No server-side date filtering is supported; filter by posted_at_date client-side after fetching. For large accounts, process pages incrementally rather than accumulating all results in memory.

Input Parameters

integer
Maximum number of transactions to return (1-1000)
string
Pagination cursor from a previous response’s next_cursor field. Pass this to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_COMPANY_CASH_ACCOUNTSRetrieve company cash (deposit) accounts one page at a time, including balances, account numbers, routing numbers, and status. Use the next cursor to retrieve additional pages; requires the ‘accounts.cash.readonly’ scope.

Input Parameters

integer
Maximum number of cash accounts to return per page. Must be between 1 and 1000.
string
Cursor for pagination. Pass the next_cursor value from a previous response to get the next page of results. Leave empty for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_COMPANY_DETAILSGet company information associated with the OAuth2 access token. Returns details including company ID, legal name, account type, and mailing address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_DEPARTMENT_BY_IDGet detailed information about a specific department by ID. Use when you need to retrieve department details for a given department identifier.

Input Parameters

string
required
Unique identifier of the department to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_EXPENSETool to get details of a specific expense by ID. Use when you need to retrieve complete information about an expense including merchant details, receipts, budget allocation, and payment status.

Input Parameters

string
required
Unique ID of the expense to retrieve
array
Get additional details for the expense by passing in expand fields. Available options: ‘location’, ‘department’, ‘merchant’, ‘receipts.download_uris’, ‘user’, ‘budget’, ‘payment’
boolean
Load custom fields for the expense

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_FIELD_BY_IDTool to retrieve a custom field by its Brex ID. Use when you need detailed information about a specific custom field.

Input Parameters

string
required
The Brex identifier of the field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_FIELD_VALUE_BY_IDRetrieve a custom field value by its parent field ID and the value’s Brex ID.

Input Parameters

string
required
The field value ID (brex_id) to retrieve
string
required
The Field Brex identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_LOCATION_BY_IDGet detailed information about a specific location by ID. Use when you need to retrieve location details for a given location identifier.

Input Parameters

string
required
Unique identifier of the location to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_REFERRALTool to retrieve a specific referral by its ID from Brex. Use when you need to check the status of a referral or get the signup URL.

Input Parameters

string
required
Unique identifier of the referral to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_SPEND_LIMIT_BY_IDTool to get detailed information about a specific spend limit by its ID. Use when you need to retrieve the configuration, status, balance, or settings of a particular spend limit.

Input Parameters

string
required
Unique ID of the spend limit to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_SPEND_LIMITSGet spend limits configuration for the account. The request retrieves one page, with a configurable limit; it cannot request subsequent pages.

Input Parameters

integer
Maximum number of spend limits to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_TITLE_BY_IDGet detailed information about a specific job title by ID. Use when you need to retrieve title details for a given title identifier.

Input Parameters

string
required
Unique identifier of the job title to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_TRANSACTION_BY_IDGet a card transaction by ID by searching up to 10 pages of transactions from the primary account. A transaction beyond the searched pages may not be found.

Input Parameters

string
required
ID of the transaction to retrieve. Transaction IDs can be obtained from the ‘Get Transactions’ action and follow the format ‘pste_…’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_TRANSACTIONSGet settled card transactions from the primary Brex account, with optional client-side posted-date filtering. Results are paginated, but filtering out items clears the next cursor, so filtered results may omit later pages.

Input Parameters

integer
Maximum number of transactions to return (1-1000)
string
Cursor for pagination to get the next page of results
string
End date for filtering transactions (client-side). Format: YYYY-MM-DD (e.g., 2024-12-31).
string
Start date for filtering transactions (client-side). Format: YYYY-MM-DD (e.g., 2024-01-01). Avoid overly long or future date ranges, which can trigger a 400 BAD_REQUEST; omit the parameter and filter posted_at_date locally instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_TRANSACTIONS_BY_AMOUNT_RANGEFind primary-account card transactions within an inclusive USD amount range and posted-date range. The search covers one page and may not include all matching transactions; the requested result limit is 1–1,000.

Input Parameters

integer
Maximum number of transactions to return in the response. Default is 100, maximum is 1000.
string
Pagination cursor from a previous response. Leave empty for the first request. Use the next_cursor value from the response to fetch the next page of results.
number
required
Maximum transaction amount in USD (e.g., 1000.00 for $1000.00). Transactions with amounts greater than this will be excluded.
number
required
Minimum transaction amount in USD (e.g., 50.00 for $50.00). Transactions with amounts less than this will be excluded.
string
required
End date for filtering transactions (inclusive) in YYYY-MM-DD format. Only transactions posted on or before this date will be included.
string
required
Start date for filtering transactions (inclusive) in YYYY-MM-DD format. Only transactions posted on or after this date will be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_TRANSACTIONS_BY_DESCRIPTIONSearch and filter card transactions by description text. This action retrieves transactions from the primary card account and filters them by description (case-insensitive partial match) and date range. Useful for finding all transactions from a specific merchant or category.

Input Parameters

integer
Maximum number of transactions to return
string
Cursor for pagination
string
required
Description text to search for in transactions. Performs case-insensitive partial matching against transaction descriptions (e.g., ‘Amazon’ matches ‘Amazon.com’, ‘uber’ matches ‘Uber Eats’)
string
required
End date for filtering transactions in YYYY-MM-DD format. Only transactions posted on or before this date will be included.
string
required
Start date for filtering transactions in YYYY-MM-DD format. Only transactions posted on or after this date will be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_USER_LIMITRetrieves the monthly spending limit and available balance for a specific Brex user. Use this action when you need to check how much a user is allowed to spend per month and how much of that limit remains available. Returns empty if no spending limit has been configured for the user.

Input Parameters

string
required
Unique identifier of the user whose spending limit information to retrieve. Must be a valid Brex user ID starting with ‘cuuser_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_USER_PROFILEGet user profile information from Brex Team API. Returns the user profile associated with the OAuth2 access token when using ‘me’, or retrieves a specific user’s profile when providing a user ID. Requires ‘users.readonly’ or ‘users’ OAuth scope.

Input Parameters

string
User ID to get profile for. Use ‘me’ to get the profile of the currently authenticated user, or provide a specific user ID to get another user’s profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_VENDOR_BY_IDTool to get vendor details by ID. Use when you need to retrieve information about a specific vendor including payment accounts.

Input Parameters

string
required
Unique vendor identifier. Can be obtained from the list_vendors endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_WEBHOOK_GROUPTool to retrieve details of a specific webhook group by ID. Use when you need to get information about a webhook group including its name and identifier. Webhook groups allow webhook subscriptions to target specific members, providing granular control over webhook delivery. This feature is only available for Brex partners. Returns the webhook group’s ID and name.

Input Parameters

string
required
The ID of the webhook group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_GET_WEBHOOK_SUBSCRIPTIONTool to retrieve details of a specific webhook subscription by ID. Use this when you need to: - Get information about an existing webhook subscription - Verify webhook configuration (URL, event types, status) - Check if a webhook subscription is active or inactive - Retrieve the webhook group ID for partner integrations Returns the webhook subscription’s ID, URL, event types, status (ACTIVE/INACTIVE), and optionally the webhook group ID.

Input Parameters

string
required
The unique identifier of the webhook subscription to retrieve. This ID is returned when creating a webhook subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_BUDGET_PROGRAMSTool to list all budget programs in the organization. Use when you need to retrieve budget programs that define spend limits for eligible users.

Input Parameters

integer
Maximum number of budget programs to return per page
string
Cursor for pagination to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_BUDGETSList a page of budgets and calculate an available-budget summary from the returned budgets.

Input Parameters

integer
Maximum number of budgets to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_CARD_ACCOUNTSTool to list all card accounts for the company. Use when you need to retrieve information about card accounts, including balances and statement periods.

Input Parameters

integer
Maximum number of card accounts to return per request. Must be between 1 and 1000.
string
Cursor for pagination. Pass the next_cursor value from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_CARDSList cards associated with the account, returning one page at a time. Use the next cursor to retrieve additional pages.

Input Parameters

integer
Maximum number of cards to return
string
Cursor for pagination. Pass the next_cursor value from a previous response to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_CARD_STATEMENTSTool to list finalized statements for primary card accounts. Use when you need to retrieve statement history for primary card accounts including balances and statement periods.

Input Parameters

integer
Maximum number of statements to return per request. Must be between 1 and 1000.
string
Cursor for pagination. Pass the next_cursor value from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_DEPARTMENTSList departments in the organization one page at a time. Use the next cursor to retrieve additional pages.

Input Parameters

integer
Maximum number of departments to return
string
Cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_EXPENSESTool to list expenses from the Brex platform. Use when you need to retrieve expenses with various filters such as user, budget, date ranges, or status. Supports pagination and expandable fields for additional details.

Input Parameters

integer
Controls the maximum number of expenses returned in the response. Cannot be greater than 1000.
string
The cursor to use for pagination. This is the next_cursor value returned from the previous response.
array
Get additional details for the expense by passing in expand options. Available options: ‘location’, ‘department’, ‘merchant’, ‘receipts.download_uris’, ‘user’, ‘budget’, ‘payment’. Example: [‘merchant’, ‘location’]
array
Filter expenses by status(es).
array
Get expenses belong to provided user(s). Filter by user IDs.
array
Filter expenses by budget ID(s).
array
Filter expenses by expense type(s).
array
Filter expenses by payment status(es).
string
Shows only expenses with an updated_at on or before this date-time. Use RFC 3339 date-time format (e.g., 2023-01-10T23:59:59.999).
string
Shows only expenses with a purchased_at on or before this date-time. Use RFC 3339 date-time format (e.g., 2023-01-10T23:59:59.999).
string
Shows only expenses with an updated_at on or after this date-time. Use RFC 3339 date-time format (e.g., 2023-01-01T23:59:59.999).
array
Get itemized expenses belong to provided parent expenses ID(s).
boolean
Load custom fields for the expenses.
string
Shows only expenses with a purchased_at on or after this date-time. Use RFC 3339 date-time format (e.g., 2023-01-01T23:59:59.999).
array
Filter expenses by spending entity ID(s).
string
Shows only expenses with a payment_posted_at on or before this date-time. Use RFC 3339 date-time format (e.g., 2023-01-10T23:59:59.999).
string
Shows only expenses with a payment_posted_at on or after this date-time. Use RFC 3339 date-time format (e.g., 2023-01-01T23:59:59.999).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_FIELD_VALUESList a page of values under a custom field, optionally filtering by Brex ID, value ID, remote ID, or value string. Use the returned cursor to retrieve subsequent pages.

Input Parameters

integer
Controls the maximum number of field values returned in the response. It can’t be greater than 1000.
string
Field value’s value to filter by. Use this to search for field values with a specific value string.
string
The cursor to use for pagination. This is the next_cursor value returned from the previous response. Omit this parameter to fetch the first page of results.
array
Field value Brex identifier(s) to filter by. Provide one or more Brex IDs to filter the results to specific field values.
string
required
The Field Brex identifier. This is the unique identifier for the custom field whose values you want to list.
array
Field value identifier(s) to filter by. Provide one or more value IDs to filter the results.
array
Field value remote identifier(s) to filter by. Provide one or more remote IDs to filter the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_LOCATIONSList locations in the organization, one page at a time. Use the returned cursor to retrieve subsequent pages.

Input Parameters

integer
Maximum number of locations to return
string
Cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_REFERRALSTool to list all referrals created in the Brex account. Use when you need to view or manage customer referrals. Note: This endpoint only returns active referrals and does not include expired ones.

Input Parameters

string
Cursor for pagination to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_TITLESList job titles in the organization, one page at a time, using a cursor to retrieve subsequent pages.

Input Parameters

integer
Maximum number of titles to return
string
Cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_TRANSFERSLists transfers for the account. Use when you need to retrieve transfer history or monitor transfer status.

Input Parameters

integer
Maximum number of transfers to return (default: 100, max: 1000)
string
Cursor for pagination to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_TRIPSLists trips according to the filters passed in the query string. Use when you need to retrieve trip history or monitor trip status.

Input Parameters

integer
Maximum number of trips to return (default: 100, max: 1000)
string
Cursor for pagination to retrieve the next page of results
string
Filter trips updated after this timestamp in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_USERSList users in the Brex account, one page at a time using a limit and pagination cursor.

Input Parameters

integer
Maximum number of users to return
string
Cursor for pagination. Pass the next_cursor value from a previous response to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_VENDORSList vendors in Brex, one page at a time using a limit and pagination cursor.

Input Parameters

integer
Maximum number of vendors to return
string
Cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_WEBHOOK_GROUP_MEMBERSTool to list all members of a webhook group. Use when you need to retrieve the webhook subscriptions that are members of a specific webhook group. Supports pagination using cursor and limit parameters.

Input Parameters

string
required
The ID of the webhook group to retrieve members for.
integer
Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
string
Cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_WEBHOOK_GROUPSTool to list all webhook groups. Use when you need to retrieve all webhook groups in the system. Webhook groups allow subscriptions to target specific members and are only available for Brex partners. Supports pagination using cursor and limit parameters.

Input Parameters

integer
Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
string
Cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_WEBHOOK_SECRETSTool to retrieve webhook signing secrets for validating incoming webhook messages from Brex. Use when you need to verify webhook authenticity. During key rotation, this may return two secrets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_LIST_WEBHOOK_SUBSCRIPTIONSTool to list all registered webhook subscriptions. Use when you need to retrieve all webhook subscriptions configured in the Brex account, including their URLs, event types, and status. Supports pagination using cursor and limit parameters.

Input Parameters

integer
Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.
string
Cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_RECEIPT_MATCHCreates a receipt match request and returns a pre-signed S3 upload URI. Use this when you need to upload a receipt that will be automatically matched to existing Brex card expenses. The returned URI allows secure file upload (max 50 MB) and expires 30 minutes after creation. After upload completes, Brex will automatically attempt to match the receipt with card transactions based on date, amount, and merchant information.

Input Parameters

string
required
The name of the receipt file including the extension (e.g., .pdf, .jpg, .png). This name will be used in the matching result email notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_RECEIPT_UPLOADCreates a receipt upload request for a specific card expense and returns a pre-signed S3 upload URL. Use this tool when you need to attach a receipt to an existing Brex card expense. The tool returns a pre-signed S3 URL that can be used to upload receipt files (PDF, JPG, PNG, etc.) up to 50 MB. The pre-signed URL expires 30 minutes after creation and can only be used for a PUT operation. Requirements: - The expense_id must belong to an existing card expense in the Brex system - The expense must be accessible by the authenticated user - Receipt file names should include the file extension (e.g., ‘receipt.pdf’, ‘invoice.jpg’) Note: For uploading receipts that should be automatically matched to expenses (without specifying an expense_id), use the BREX_RECEIPT_MATCH action instead.

Input Parameters

string
required
The unique identifier of the card expense to attach the receipt to. This must be a valid expense ID from the Brex system, typically starting with ‘expense_’. You can obtain expense IDs using the list_expenses or list_card_expenses actions.
string
required
The filename for the receipt including the file extension. Common formats include PDF (.pdf), JPEG (.jpg, .jpeg), and PNG (.png). The filename should be descriptive and must include the extension. Maximum file size for upload is 50 MB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_SET_USER_LIMITSet or update a Brex user’s monthly spending limit, with amounts in the smallest currency unit. A null or omitted monthly limit requests removal of the existing limit.

Input Parameters

string
required
Unique identifier of the user to set the limit for. Must be a valid Brex user ID with the ‘cuuser_’ prefix.
object
Monetary amount with currency.
string
Optional idempotency key to ensure the request is processed only once. Use the same key for retries to prevent duplicate limit updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_TRANSFER_CARDTransfer a card to a different user.

Input Parameters

string
required
ID of the card to transfer
string
required
User ID of the new card owner

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_BUDGETUpdate an existing budget’s configuration in Brex. This action allows you to modify budget properties such as name, description, amount limits, ownership, parent budget relationships, and recurrence settings. Only the fields you provide will be updated; all other fields remain unchanged. Common use cases: - Adjust budget amounts (increase or decrease limits) - Change budget ownership or reassign to different users - Update budget names and descriptions for clarity - Modify recurrence periods (e.g., change from MONTHLY to QUARTERLY) - Reorganize budget hierarchy by changing parent budgets

Input Parameters

string
New name for the budget. If not provided, the current name remains unchanged.
object
Monetary amount allocated for the budget.
string
required
ID of the budget to update. This is the unique identifier returned when the budget was created or listed.
string
New description for the budget. If not provided, the current description remains unchanged.
array
List of user IDs who should own this budget. Replaces the existing owner list. If not provided, current owners remain unchanged.
string
Idempotency key to ensure request is processed only once. For retry safety, generate once and reuse the same key for retries. Auto-generated if not provided. Recommended format: V4 UUID.
string
ID of the parent budget. Used to reorganize budget hierarchy. If not provided, the parent budget relationship remains unchanged.
string
Budget period recurrence type. Common values: MONTHLY, QUARTERLY, YEARLY. If not provided, current recurrence type remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_BUDGET_V1Tool to update a Spend Limit (budget) using the v1 API. Use when you need to modify budget details such as name, description, owners, members, limits, or date ranges.

Input Parameters

string
required
Unique ID of the Spend Limit to update.
string
Name for the Spend Limit.
object
Monetary limit amount with currency.
string
The UTC date when the Spend Limit should stop counting, in YYYY-MM-DD format.
string
Type of limit enforcement.
string
Type of spending tracked by this Spend Limit.
string
The UTC date when the Spend Limit should start counting, in YYYY-MM-DD format.
string
Description of what the Spend Limit is used for.
string
Period type of the Spend Limit.
array
User IDs of the owners of the Spend Limit.
string
Idempotency key for the request. For retry safety, clients should generate, store, and reuse the same key when retrying failed operations. If not provided, a UUID will be auto-generated. Recommended format: V4 UUID.
array
User IDs of the members of the Spend Limit.
string
Visibility setting for the Spend Limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_CARD_LIMITSUpdate spending limits and controls for a Brex card. This action allows you to modify the spending limits, duration, and lock date for cards that have limit_type=CARD. You can update one or more spend control settings while leaving others unchanged. Cards with limit_type=USER inherit limits from the user and cannot be updated with this action.

Input Parameters

string
required
Unique identifier of the card to update limits for. Must be a valid card ID from the Brex system. You can obtain card IDs using the BREX_LIST_CARDS action.
object
required
New spend control settings to apply to the card. At least one field (spend_limit, spend_duration, or lock_after_date) should be provided to make a meaningful update. Only applicable for cards with limit_type=CARD (not USER-level limits). Fields left as None will remain unchanged on the card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_CARD_STATUSUpdate the status of a Brex card by locking, unlocking, or terminating it. This action provides a unified interface for card status management: - Lock a card to temporarily block transactions (requires lock_reason) - Unlock a locked card to resume normal operation - Terminate a card permanently (cannot be undone) The action uses the appropriate Brex API endpoint based on the target status.

Input Parameters

string ("LOCKED" | "ACTIVE" | "TERMINATED")
required
The target status for the card. LOCKED: Temporarily disable the card (can be unlocked later). ACTIVE: Unlock a locked card to enable transactions. TERMINATED: Permanently disable the card (cannot be undone).
string
required
The unique identifier of the card to update (e.g., ‘ncard_abc123’). You can obtain card IDs from the List Cards action.
string ("CARD_DAMAGED" | "CARD_LOST" | "CARD_NOT_RECEIVED" | "DO_NOT_NEED_PHYSICAL_CARD" | "DO_NOT_NEED_VIRTUAL_CARD" | "OTHER")
Valid reasons for locking a card.
string
Optional description providing additional context when locking a card. Maximum 300 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_EXPENSEUpdate a card expense by ID, modifying one or more of its memo, location, department, or category fields in a single request.

Input Parameters

string
Expense memo to update. Provide a string to set or update the memo, or explicitly set to empty string to clear it.
string
Expense category to classify the expense. Common categories include expense types like ADVERTISING_AND_MARKETING, MEALS_AND_ENTERTAINMENT, etc.
string
required
ID of the expense to update
string
Location ID to associate with the expense. Provide a valid location ID to update.
string
Department ID to associate with the expense. Provide a valid department ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_FIELDTool to update a custom field in Brex. Use when you need to modify a field’s name or disable/enable it.

Input Parameters

string
required
The Brex identifier of the field to update
string
The name of the field
boolean
Indicates if the field is disabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_FIELD_VALUESTool to update custom field values in Brex for a specific field. Use when you need to modify existing field values, supporting batch updates of up to 1000 values at once. Each value can be identified by brex_id (entity identifier), value_id (field value ID), or remote_id (external system ID). The API will update the field values and return the complete updated state including metadata like updated_at timestamps.

Input Parameters

array
required
List of field values to update. Each item must specify exactly one identifier (brex_id, value_id, or remote_id) and the new value data. Maximum 1000 items per request.
string
required
The unique identifier of the custom field whose values you want to update. Must be a valid field ID from Brex.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_SPEND_LIMITUpdates an existing Brex spend limit by its ID. Allows modifying spend limit properties including name, description, status (ACTIVE/INACTIVE), period settings, authorization controls, spending limits, merchant restrictions, member/owner assignments, and policy associations. At least one optional field must be provided to update. Requires the spend limit ID from BREX_GET_SPEND_LIMITS or creation actions.

Input Parameters

string
required
Unique ID of the spend limit to update.
string
Name for the Spend Limit.
string
Status of the spend limit. Use ‘ACTIVE’ to enable spending, ‘INACTIVE’ to temporarily pause/disable spending without archiving the limit.
string
The date when the Spend Limit should expire, in ISO 8601 date format (YYYY-MM-DD).
string
Controls what types of spending are allowed. ‘NON_BUDGET_PROVISIONED_CARDS_ALLOWED’ allows both budget cards and regular cards, ‘BUDGET_PROVISIONED_CARDS_ONLY’ restricts to only budget-provisioned cards, ‘NON_BUDGET_PROVISIONED_CARDS_ONLY’ allows only non-budget cards.
string
The date when the Spend Limit should start counting, in ISO 8601 date format (YYYY-MM-DD).
string
Description of what the Spend Limit is used for.
string
The department ID to which Spend Limit expenses will be attributed.
array
User IDs of the owners of the Spend Limit.
string
Idempotency key for the request. For retry safety, clients should generate, store, and reuse the same key when retrying failed operations. If not provided, a UUID will be auto-generated. Recommended format: V4 UUID.
The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity.
array
User IDs of the members of the Spend Limit.
string
The ID of the expense policy corresponding to this Spend Limit.
object
Per-transaction spending limit.
string
Controls who can view expenses made under this spend limit. ‘PRIVATE’ = only owners can view, ‘PUBLIC’ = all members can view expenses.
object
Authorization settings controlling how the spend limit enforces spending.
string
Whether members can request temporary limit increases. ‘ENABLED’ allows increase requests, ‘DISABLED’ prevents them.
string
How often the spend limit resets. Valid values: ‘MONTHLY’ (resets each month), ‘QUARTERLY’ (resets every 3 months), ‘YEARLY’ (resets annually), ‘ONE_TIME’ (never resets, single-use limit).
string
Controls who can view card authorizations made under this spend limit. ‘PRIVATE’ = only owners can view, ‘PUBLIC’ = all members can view authorizations.
string
The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.
object
Merchant category controls for spend limit.
string
Whether to automatically transfer cards from parent budget when members are added. ‘ENABLED’ auto-transfers cards, ‘DISABLED’ requires manual card transfer.
string
Whether to automatically create cards for members when they’re added to this spend limit. ‘ENABLED’ auto-creates cards, ‘DISABLED’ requires manual card creation.
string
The ID of the policy for limit increase requests for this Spend Limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_USERUpdate a Brex user’s manager, department, location, or title by user ID.

Input Parameters

string
required
ID of the user to update
string
Title ID
string
User ID of the manager
string
Location ID
string
Department ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_VENDORTool to update vendor information in Brex. Use when you need to modify vendor details such as company name, email, phone, payment accounts, or beneficiary information.

Input Parameters

string
required
Unique vendor identifier to update
string
Email for vendor
string
Phone number for vendor
string
Name for vendor
string
Idempotency key for the request. For retry safety, clients should generate, store, and reuse the same key when retrying failed operations. Recommended format: V4 UUID.
string
Name for the Beneficiary
array
To update payment instruments, provide the payment details without the payment_instrument_id (it’s read-only). Include all required fields for the payment type (e.g., routing_number, account_number for ACH).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREX_UPDATE_WEBHOOK_SUBSCRIPTIONUpdates an existing Brex webhook subscription’s configuration by ID. The URL, event types, and status must all be supplied; an optional webhook group ID can be supplied for partner integrations.

Input Parameters

string
required
The unique identifier of the webhook subscription to update. This ID starts with ‘wsub_’ and can be obtained from listing webhook subscriptions or from the creation response.
string
required
The HTTPS URL endpoint where webhook event notifications will be sent via POST requests. Must be a publicly accessible HTTPS URL (HTTP not supported). The endpoint should be able to receive and process JSON payloads containing webhook events.
string ("ACTIVE" | "INACTIVE")
required
The operational status of the webhook subscription. Use ‘ACTIVE’ to enable webhook event delivery or ‘INACTIVE’ to temporarily pause delivery without deleting the subscription. When INACTIVE, events will not be sent to the webhook URL.
string
Optional webhook group ID (format: ‘wg_*’) for partner integrations only. This associates the subscription with a specific group of related webhooks. If not provided or null, the subscription operates independently without group association. Most users should leave this empty.
array
required
List of Brex event types that will trigger webhook notifications to the specified URL. Must include at least one event type. Available types include: TRANSFER_PROCESSED, TRANSFER_FAILED, USER_UPDATED, EXPENSE_PAYMENT_UPDATED, and various EMBEDDED_* events for embedded banking features. Select only the events relevant to your integration to reduce unnecessary webhook traffic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not