View as Markdown
Navan icon

Navan ACTION

List Users

Retrieves a paginated list of all users in the company. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Navan 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: "navan-list-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    navan: { authProvisionId: "apn_xxxxxxx" },
    startIndex: 10,
    count: 10,
  },
})

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
startIndex Start Index integer
0-based index of first result. Default is 0.
Optional
count Count integer
Number of resources to return per page. Default is 10.
Optional
filter Filter string
SCIM filter expression. Supported filters like userName eq "email@example.com"
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
navan-list-users
Version
0.0.2
App
Navan
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes