# Get All Leads — Pipedrive

> Get all leads from Pipedrive. See the documentation

- Key: `pipedrive-get-all-leads`
- Type: Action (Read-only)
- Version: 0.0.6
- App: Pipedrive (`pipedrive`) — https://pipedream.com/apps/pipedrive.md
- This page (HTML): https://pipedream.com/apps/pipedrive/actions/get-all-leads
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/pipedrive/actions/get-all-leads/get-all-leads.mjs

## Description

Get all leads from Pipedrive. [See the documentation](https://developers.pipedrive.com/docs/api/v1/Leads#getLeads)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `maxResults` | `integer` | No | The maximum number of results to return. If not provided, all leads will be returned. |
| `ownerId` | `integer` | No | If supplied, only leads matching the given user will be returned. However, Filter ID takes precedence over Owner ID when supplied. Options are loaded from the connected account. |
| `personId` | `integer` | No | If supplied, only leads matching the given person will be returned. However, Filter ID takes precedence over Person ID when supplied. Options are loaded from the connected account. |
| `organizationId` | `integer` | No | If supplied, only leads matching the given organization will be returned. However, Filter ID takes precedence over Organization ID when supplied. Options are loaded from the connected account. |
| `filterId` | `integer` | No | The ID of the filter to use. Takes precedence over Owner ID, Person ID, and Organization ID when supplied. Options are loaded from the connected account. |
| `sort` | `string` | No | The field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Valid fields: id, title, owner_id, creator_id, was_seen, expected_close_date, next_activity_id, add_time, update_time |

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

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: "pipedrive-get-all-leads",
  arguments: {
    maxResults: 10,
    ownerId: 10,
  },
})
```

**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: "pipedrive-get-all-leads",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pipedrive: { authProvisionId: "apn_xxxxxxx" },
    maxResults: 10,
    ownerId: 10,
  },
})

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": "pipedrive-get-all-leads",
    "configured_props": {
      "pipedrive": { "authProvisionId": "apn_xxxxxxx" },
      "maxResults": 10,
      "ownerId": 10
    }
  }'
```

---

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