View as Markdown
Grain icon

Grain ACTION

List Users

Lists the users in your Grain workspace (id, name, email). Use this to resolve a user's ID before sharing a recording with them via Manage Recording Sharing, or to identify who's who when reviewing recording participants. Example: returns [{"id": "d91b7ed0-a149-425c-9623-0664148e4fc1", "name": "Danny Archer", "email": "darcher@pipedream.com"}]. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Grain account once, then configure and run List Users 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: "grain-list-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    grain: { authProvisionId: "apn_xxxxxxx" },
  },
})

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.

List Users inputs
Property Type Description

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
grain-list-users
Version
0.0.1
App
Grain
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes