View as Markdown
Ramp (Sandbox Version) icon

Ramp (Sandbox Version) ACTION

List Locations

Retrieve a list of Ramp Sandbox locations. Use this to find location IDs for other actions such as Update User and List Transactions. Example: returns objects like { "id": "961c6f01-5719-4f4c-8fef-4096a031f32a", "name": "New York HQ", "entity_id": "c0e5f8a2-9b1d-4e3a-8f6c-2d7b4a1e9f30" } — pass the id as the location ID in downstream actions. Returns one page of up to pageSize results (max 100); a page.next value in the response means more locations 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 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: "ramp_sandbox-list-locations",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ramp_sandbox: { authProvisionId: "apn_xxxxxxx" },
    pageSize: 10,
    start: "Start (Pagination Cursor)",
  },
})

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
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

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-locations
Version
0.0.2
App
Ramp (Sandbox Version)
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes