# List Users — Brex

> Lists the people in the Brex account with their ID, name, email, status, manager, department, and location. Filter to one person with email, or set includeLimits to include each person's monthly spend limit. Results are capped at…

- Key: `brex-list-users`
- Type: Action (Read-only)
- Version: 0.0.3
- App: Brex (`brex`) — https://pipedream.com/apps/brex.md
- This page (HTML): https://pipedream.com/apps/brex/actions/list-users
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/brex/actions/list-users/list-users.mjs

## Description

Lists the people in the Brex account with their ID, name, email, status, manager, department, and location. Filter to one person with `email`, or set `includeLimits` to include each person's monthly spend limit. Results are capped at `maxResults` (default `100`) — check `$summary` for a truncation notice and raise `maxResults` or add the `email` filter if it's truncated. This is how you turn an email address into the user ID that **Get User**, **Get User Limit**, and **Set Limit for User** require. [See the documentation](https://developer.brex.com/openapi/team_api/users/listusers)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `email` | `string` | No | Return only the user with this exact email address, e.g. jane@acme.com. Brex supports a single email at a time, not a list. |
| `includeLimits` | `boolean` | No | Return each person's monthly spend limit alongside their profile. Amounts are in the currency's smallest denomination, so 700 is $7.00 in USD. |
| `maxResults` | `integer` | No | The maximum number of records to return, from 1 to 2000. Defaults to 100. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "brex",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "brex-list-users",
  arguments: {
    email: "Email",
    includeLimits: true,
  },
})
```

**TypeScript**

```ts
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-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    brex: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    includeLimits: true,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "brex-list-users",
    "configured_props": {
      "brex": { "authProvisionId": "apn_xxxxxxx" },
      "email": "Email",
      "includeLimits": true
    }
  }'
```

---

- App: https://pipedream.com/apps/brex.md · All apps: https://pipedream.com/apps