View as Markdown
Superdocu icon

Superdocu ACTION

List Dossiers

List the dossiers (the API calls these contact workflows) assigned to a specific Superdocu contact. Returns an array of dossier objects, each with an id (the contact-workflow ID) and a status. Run List Contacts first to obtain a valid contactId. Use a returned dossier id as the contactWorkflowId input to Get Dossier or Delete Dossier. 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 Dossiers 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-dossiers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    superdocu: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact ID",
    limit: 10,
  },
})

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 Dossiers inputs
Property Type Description
contactId Contact ID string
The numeric ID of the contact, as a string (e.g. "56031"). Run List Contacts first to obtain a valid contact ID — it is the id field on each returned contact (do NOT pass the contact's email here).
Required
limit Limit integer
Maximum number of dossiers 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-dossiers
Version
0.0.2
App
Superdocu
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes