View as Markdown
IntelliHR icon

IntelliHR ACTION

Find Person

Searches for a person in intellihr using. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's IntelliHR account once, then configure and run Find Person 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: "intellihr-find-person",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    intellihr: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    email: "Email",
  },
})

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.

Find Person inputs
Property Type Description
name Name string
Name of a Person in the system. This filter checks for an exact string match with any part of a Persons name. This filter is performed case insensitively and regardless of name order
Optional
email Email string
The email address of the person
Optional
employeeNumber Employee Number string
A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.
Optional
jobId Job ID string
Identifier of a Job
Optional Dynamic
updatedWithin Updated Within integer
Filters people that have been updated within the specified amount of days.
Optional
isOnExtendedLeave Is On Extended Leave boolean
Filters people that are on extended leave.
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
intellihr-find-person
Version
0.0.2
App
IntelliHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes