View as Markdown
Ramp (Sandbox Version) icon

Ramp (Sandbox Version) ACTION

List Users

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
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ramp (Sandbox Version) account once, then configure and run List Users 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: "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)

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 Users inputs
Property Type Description
departmentId Department ID string
Filter by department ID — a Ramp UUID, e.g. fffe6c22-698f-4dc5-b2b1-b35f86947d90. Run the List Departments action to find valid IDs.
Optional
locationId Location ID string
Filter by location ID — a Ramp UUID, e.g. 961c6f01-5719-4f4c-8fef-4096a031f32a. Run the List Locations action to find valid IDs.
Optional
email Email string
Filter by user email address.
Optional
role Role string
Filter by user role.
Optional
status Status string
Filter by user status (e.g. USER_ACTIVE).
Optional
pageSize Page Size integer
Number of results per page, between 2 and 100 (default 20).
Optional
start Start (Pagination Cursor) string
Pagination cursor for the next page. Take the start query-parameter value from the previous response's page.next URL and pass it here.
Optional
fields Fields string[]
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.
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
ramp_sandbox-list-users
Version
0.0.2
App
Ramp (Sandbox Version)
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes