View as Markdown
Brex icon

Brex ACTION

List Locations

Lists the office locations configured in the Brex account with their ID and name. Results are capped at maxResults (default 100) — check $summary for a truncation notice and raise maxResults if it's truncated. This is how you turn a location name into the location ID that Invite User requires. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Brex account once, then configure and run List Locations from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "brex-list-locations",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    brex: { authProvisionId: "apn_xxxxxxx" },
    maxResults: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Locations inputs
Property Type Description
maxResults Max Results integer
The maximum number of records to return, from 1 to 2000. Defaults to 100.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
brex-list-locations
Version
0.0.1
App
Brex
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes