View as Markdown
Fathom icon

Fathom ACTION

List Users and Permissions

List the users on the account and their admin permissions (settings access level and view access). Admin-only — the connected account must have account_admin settings access, or the request fails with a 403 error. Use List Teams to find a valid team name to filter by. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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 and Permissions inputs
Property Type Description
teamName Team string
Filter by team name, e.g. Sales. Use List Teams to find valid team names.
Optional
status Status string
Filter by user account status. invited cannot be combined with Settings Access Level.
Optional
settingsAccess Settings Access Level string
Filter by admin settings access level.
Optional
cursor Cursor string
Opaque pagination cursor for fetching the next page of results. Use the next_cursor value returned in the previous response, e.g. eyJwYWdlX251bSI6Mn0=. Omit to fetch the first page.
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
fathom-list-users
Version
0.0.2
App
Fathom
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes