View as Markdown
Freshchat icon

Freshchat ACTION

Get User

Retrieves a single Freshchat user (the customer in a chat) by ID, including first_name, last_name, email, phone, and custom properties (an array of {name, value} objects). Use this to resolve who a conversation belongs to. The user ID is returned as user_id (or actor_id when actor_type is user) by List Messages, and as user_id on conversations. Returns a 404 error if no user exists with the given ID. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Freshchat account once, then configure and run Get User 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: "freshchat-get-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    freshchat: { authProvisionId: "apn_xxxxxxx" },
    userId: "User 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 User inputs
Property Type Description
userId User ID string
The ID of the user to retrieve, e.g. 2deb2a22-703e-4f1d-8527-7bd123c84fd4. Take it from conversation.user_id or actor_id (when actor_type is user) in List Messages, or select one from the list.
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
freshchat-get-user
Version
0.0.1
App
Freshchat
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes