View as Markdown
Copper icon

Copper ACTION

Get Object

Retrieves an existing CRM object. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Copper account once, then configure and run Get Object 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: "copper-get-object",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    copper: { authProvisionId: "apn_xxxxxxx" },
    objectType: "Object Type",
    objectId: "Object 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 Object inputs
Property Type Description
objectType Object Type string
The type of CRM object
Required Dynamic
objectId Object ID string
The ID of the CRM object
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
copper-get-object
Version
0.0.3
App
Copper
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes