View as Markdown
Kustomer icon

Kustomer ACTION

Get Custom Object by External ID

Gets a custom object by external ID in Kustomer. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Kustomer account once, then configure and run Get Custom Object by External ID 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: "kustomer-get-custom-object-by-external-id",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    kustomer: { authProvisionId: "apn_xxxxxxx" },
    klassName: "Klass Name",
    externalId: "External 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 Custom Object by External ID inputs
Property Type Description
klassName Klass Name string
Klass name of the KObjects (custom objects)
Required Dynamic
externalId External ID string
The external ID of the custom object to retrieve
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
kustomer-get-custom-object-by-external-id
Version
0.0.2
App
Kustomer
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes