# List Locations — Ramp

> Retrieve a list of Ramp 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"…

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

## Description

Retrieve a list of Ramp 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](https://docs.ramp.com/developer-api/v1/api/locations#get-developer-v1-locations)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `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. |

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

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-list-locations",
  arguments: {
    pageSize: 10,
    start: "Start (Pagination Cursor)",
  },
})
```

**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-list-locations",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ramp: { authProvisionId: "apn_xxxxxxx" },
    pageSize: 10,
    start: "Start (Pagination Cursor)",
  },
})

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-list-locations",
    "configured_props": {
      "ramp": { "authProvisionId": "apn_xxxxxxx" },
      "pageSize": 10,
      "start": "Start (Pagination Cursor)"
    }
  }'
```

---

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