View as Markdown
Parma icon

Parma ACTION

Find Relationship

Searches for an existing relationship in Parma. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Parma account once, then configure and run Find Relationship 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: "parma-find-relationship",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    parma: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    type: "Type",
  },
})

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.

Find Relationship inputs
Property Type Description
name Name string
The name of the relationship.
Optional
type Type string
The type of relationship.
Optional
email Email string
The email of the relationship.
Optional
whatsapp Whatsapp string
The whatsapp of the relationship.
Optional
phone Phone string
The phone of the relationship.
Optional
sms SMS string
The SMS of the relationship.
Optional
telegram Telegram string
The telegram of the relationship.
Optional
twitter Twitter string
The twitter of the relationship.
Optional
instagram Instagram string
The instagram of the relationship.
Optional
linkedin LinkedIn string
The linkedin of the relationship.
Optional
schedulinglink Scheduling Link string
The scheduling link of the relationship.
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
parma-find-relationship
Version
0.0.2
App
Parma
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes