# List Users — Ramp (Sandbox Version)

> Retrieve a paginated list of Ramp Sandbox users, optionally filtered by department, location, email, role, or status. Returns a compact summary of each user by default (id, first_name, last_name, email, role, status, department_id…

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

## Description

Retrieve a paginated list of Ramp Sandbox users, optionally filtered by department, location, email, role, or status. Returns a compact summary of each user by default (id, first_name, last_name, email, role, status, department_id, location_id, manager_id, is_manager); use **Get User** for the full record, or pass `fields` to include specific extra fields. Use this to discover valid user IDs for **Get User** and **Update User**. Returns one page of up to `pageSize` results (max 100); a `page.next` value in the response means more users exist beyond this page. [See the documentation](https://docs.ramp.com/developer-api/v1/api/users#get-developer-v1-users)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `departmentId` | `string` | No | Filter by department ID — a Ramp UUID, e.g. fffe6c22-698f-4dc5-b2b1-b35f86947d90. Run the List Departments action to find valid IDs. |
| `locationId` | `string` | No | Filter by location ID — a Ramp UUID, e.g. 961c6f01-5719-4f4c-8fef-4096a031f32a. Run the List Locations action to find valid IDs. |
| `email` | `string` | No | Filter by user email address. |
| `role` | `string` | No | Filter by user role. |
| `status` | `string` | No | Filter by user status (e.g. USER_ACTIVE). |
| `pageSize` | `integer` | No | Number of results per page, between 2 and 100 (default 20). |
| `start` | `string` | No | Pagination cursor for the next page. Take the start query-parameter value from the previous response's page.next URL and pass it here. |
| `fields` | `string[]` | No | Optional list of user fields to include per record in addition to the compact default (e.g. custom_fields, phone, business_id). Leave empty for the compact summary; use Get User for the complete record. |

## 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": "ramp_sandbox",
      },
    },
  },
)

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: "ramp_sandbox-list-users",
  arguments: {
    departmentId: "Department ID",
    locationId: "Location ID",
  },
})
```

**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: "ramp_sandbox-list-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ramp_sandbox: { authProvisionId: "apn_xxxxxxx" },
    departmentId: "Department ID",
    locationId: "Location ID",
  },
})

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": "ramp_sandbox-list-users",
    "configured_props": {
      "ramp_sandbox": { "authProvisionId": "apn_xxxxxxx" },
      "departmentId": "Department ID",
      "locationId": "Location ID"
    }
  }'
```

---

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