View as Markdown
Sperse icon

Sperse ACTION

Get Contact Details

Retrieves detailed information about a contact. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sperse account once, then configure and run Get Contact Details 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: "sperse-get-contact-details",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sperse: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact 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 Contact Details inputs
Property Type Description
contactId Contact ID string
The ID of the contact
Required Dynamic

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
sperse-get-contact-details
Version
0.0.1
App
Sperse
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes