# List Contacts — Givebutter

> List contacts/donors from the authenticated Givebutter account. Returns a paginated array of contact objects (each includes at minimum id, primary_email, first_name, and last_name). Note that the API returns only individual contacts unless…

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

## Description

List contacts/donors from the authenticated Givebutter account. Returns a paginated array of contact objects (each includes at minimum `id`, `primary_email`, `first_name`, and `last_name`). Note that the API returns only `individual` contacts unless **Type** is set to `company`. Use this to discover contact IDs before calling **Update Contact**. [See the documentation](https://docs.givebutter.com/api-reference/contacts/list-all-contacts)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `type` | `string` | No | Contact type to list. The Givebutter API defaults to individual, so company contacts are omitted unless this is explicitly set to company. |
| `email` | `string` | No | Optional exact email to filter contacts by (maps to the API email query param). Example: jane@example.com. |
| `sortBy` | `string` | No | Optional field to sort by. |
| `page` | `integer` | No | 1-indexed page number for offset-based pagination (Givebutter default: 1). |
| `limit` | `integer` | No | Maximum number of results to return per page (maps to per_page). Must be between 1 and 100 (the Givebutter API caps per_page at 100). Defaults to the API default of 20 if omitted. |

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

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: "givebutter-list-contacts",
  arguments: {
    type: "Type",
    email: "Email",
  },
})
```

**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: "givebutter-list-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    givebutter: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    email: "Email",
  },
})

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": "givebutter-list-contacts",
    "configured_props": {
      "givebutter": { "authProvisionId": "apn_xxxxxxx" },
      "type": "Type",
      "email": "Email"
    }
  }'
```

---

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