View as Markdown
Superdocu icon

Superdocu ACTION

Get Dossier

Retrieve the full detail of a single dossier (the API calls this a contact workflow), including its states. Run List Contacts first to obtain a contactId, then List Dossiers for that contact to obtain a contactWorkflowId. 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 Get Dossier 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-get-dossier",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    superdocu: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact ID",
    contactWorkflowId: "Dossier ID (Contact Workflow ID)",
  },
})

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.

Get Dossier 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
contactWorkflowId Dossier ID (Contact Workflow ID) string
The numeric ID of the dossier (contact workflow), as a string (e.g. "88748"). Run List Dossiers for the relevant contact first to obtain a valid ID — it is the id field on each returned dossier.
Required

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-get-dossier
Version
0.0.2
App
Superdocu
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes