View as Markdown
Universal API icon

Universal API ACTION

List HRIS Employees

List employees from the connected HRIS integration on Universal API. Returns an array of employee objects (paginated internally, up to maxResults); use the returned IDs with Get HRIS Employee. Provide serviceId only when the consumer has multiple active HRIS integrations. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Universal API account once, then configure and run List HRIS Employees 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: "universal_api-list-hris-employees",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    universal_api: { authProvisionId: "apn_xxxxxxx" },
    consumerId: "Consumer ID",
    serviceId: "Service 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.

List HRIS Employees inputs
Property Type Description
consumerId Consumer ID string
The consumer ID. Run List Consumers first to find valid IDs.
Required
serviceId Service ID string
x-uapi-service-id header identifying which HRIS integration to use (required by the API for this endpoint). One of: bamboohr, google-workspace, azure-active-directory, catalyst-one, haileyhr, deel, sap.
Required
group Group string
Filter employees by group name.
Optional
maxResults Max Results integer
The maximum number of results to return across all pages. Between 1 and 1000. Omit to return all available results.
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
universal_api-list-hris-employees
Version
0.0.2
App
Universal API
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes