View as Markdown
Superdocu icon

Superdocu ACTION

List Contacts

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.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Superdocu account once, then configure and run List Contacts 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: "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)

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 Contacts inputs
Property Type Description
status Status string
Filter contacts by status. One of: enabled, disabled, critical, watch, invited.
Optional
query Query string
Free-text search across contact fields (maps to filter[q]).
Optional
tagIds Tag IDs string[]
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].
Optional
assignedTo Assigned To string
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].
Optional
limit Limit integer
Maximum number of contacts to return per page (min 1, max 100; the Superdocu API rejects values above 100). Defaults to 25.
Optional
after After Cursor string
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.
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
superdocu-list-contacts
Version
0.0.2
App
Superdocu
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes