# List Contacts — Superdocu

> List contacts in Superdocu. Returns an array of contact objects, each with a numeric id (e.g. "56031") — this id (not the email) is the value to pass as contactId to List Dossiers, Create Dossier, Get Dossier, Delete Dossier, and Invite…

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

## Description

List contacts in Superdocu. Returns an array of contact objects, each with a numeric `id` (e.g. `"56031"`) — this `id` (not the email) is the value to pass as **contactId** to **List Dossiers**, **Create Dossier**, **Get Dossier**, **Delete Dossier**, and **Invite Contact**. The `email` field is for reference/display only; downstream tools do not accept it. Supports filtering by status, free-text query, tag, and assignee. [See the documentation](https://developers.superdocu.com/api/index.html).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `status` | `string` | No | Filter contacts by status. One of: enabled, disabled, critical, watch, invited. |
| `query` | `string` | No | Free-text search across contact fields (maps to filter[q]). |
| `tagIds` | `string[]` | No | Filter by tag IDs. Each value is the numeric tag ID as a string (e.g. "12"). Tag IDs are managed in the Superdocu UI under Settings → Tags — this MCP tool set does not expose a list-tags endpoint, so the caller must already know the ID. Multiple values are sent as a CSV via filter[tag_id]. |
| `assignedTo` | `string` | No | Filter by the ID of the Superdocu user (team member) the contact is assigned to. The value is the numeric user ID as a string (e.g. "42"); obtain it from the Superdocu UI under Settings → Team — this MCP tool set does not expose a list-users endpoint. Maps to filter[assigned_to]. |
| `limit` | `integer` | No | Maximum number of contacts to return per page (min 1, max 100; the Superdocu API rejects values above 100). Defaults to 25. |
| `after` | `string` | No | Cursor for forward pagination — an opaque string returned by the API (e.g. "eyJpZCI6MTAwfQ=="). Pass the meta.next_cursor value from a previous response verbatim to fetch the next page. Leave empty to start from the first page. |

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

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: "superdocu-list-contacts",
  arguments: {
    status: "Status",
    query: "Query",
  },
})
```

**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: "superdocu-list-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    superdocu: { authProvisionId: "apn_xxxxxxx" },
    status: "Status",
    query: "Query",
  },
})

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": "superdocu-list-contacts",
    "configured_props": {
      "superdocu": { "authProvisionId": "apn_xxxxxxx" },
      "status": "Status",
      "query": "Query"
    }
  }'
```

---

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